{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Lookup Query",
"description": "**Lookup Query API**:\n\n
Lookup Query API retrieves lookups and aggregates.\n\n
**Lookup Query API provides**:
- The ability to query for Lookups.
- The ability to query for a Lookup Instance. That includes searching by Lookup ID.
",
"version": "1.0"
},
"servers": [
{
"url": "/lookupquery"
}
],
"paths": {
"/api/lookup": {
"get": {
"tags": [
"Lookup"
],
"summary": "Gets all Lookups for the client tenant.",
"description": "\nThis method returns all Lookups for given tenant
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLookups",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Lookup"
],
"summary": "Gets a list of lookups and their active version from a list of Ids",
"description": "\nThis method returns a list of lookups with their active version from a list of Ids
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupsByIds",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByIdsRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. A list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/active": {
"get": {
"tags": [
"Lookup"
],
"summary": "Gets all Lookups active version for the client tenant.",
"description": "\nThis method returns all Lookups with only the active for a given tenant
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllActiveLookups",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/lite": {
"get": {
"tags": [
"Lookup"
],
"summary": "Gets all Lookups (lite)",
"description": "\nThis method returns all Lookups for given tenant.\n This is lite endpoint and will not return the definitions of the values and signees.
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLookupsLite",
"parameters": [
{
"name": "includeNotes",
"in": "query",
"description": "Indicates whether the result should contain versions with Notes field value included.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLiteDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/lite/v2": {
"get": {
"tags": [
"Lookup"
],
"summary": "Gets all Lookups V2 (lite) with the option of including/excluding versions",
"description": "\nThis method returns all Lookups with/without their underlying versions for given tenant.\n This is lite endpoint and will not return the definitions of the values and signees.
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLookupsLiteV2",
"parameters": [
{
"name": "includeNotes",
"in": "query",
"description": "Indicates whether the result should contain versions with Notes field value included.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "requireVersions",
"in": "query",
"description": "Indicates whether versions are required in the response.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLiteV2DtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/lite/paged": {
"get": {
"tags": [
"Lookup"
],
"summary": "Gets all Lookups (lite) paged",
"description": "\nThis method returns all Lookups for given tenant.\n This is lite endpoint and will not return the definitions of the values and signees .
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLookupsLitePaged",
"parameters": [
{
"name": "includeNotes",
"in": "query",
"description": "Indicates whether the result should contain versions with Notes field value included.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "paginationToken",
"in": "query",
"description": "Token to retrieve more results",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32",
"default": 150
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLiteDtoItemsPageServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/counts/total": {
"get": {
"tags": [
"Lookup"
],
"summary": "Retrieves the total count of Lookups for the client tenant.",
"description": "
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupsTotalCount",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}": {
"get": {
"tags": [
"Lookup"
],
"summary": "Get the active version of an existing Lookup by ID",
"description": "\nThis method returns the active, currently in effect, published version for a given lookup
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupById",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The id of the lookup to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. A Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}/version/{versionNumber}": {
"get": {
"tags": [
"Lookup"
],
"summary": "Get a specific version of an existing Lookup",
"description": "\nThis method returns the, specified by number, version for a given Lookup
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupVersionById",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The Id of the existing model",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "The version number to retrieve",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. A Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id/version does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/name/{lookupName}": {
"get": {
"tags": [
"Lookup"
],
"summary": "Get the active version of an existing Lookup by Name",
"description": "\nThis method returns the active, currently in effect, published version for a given lookup
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupByName",
"parameters": [
{
"name": "lookupName",
"in": "path",
"description": "The name of the lookup to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. A Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}/detailed": {
"get": {
"tags": [
"Lookup"
],
"summary": "Get detailed lookup by ID with all versions",
"description": "\nThis method returns the detailed lookup with all versions
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetDetailedLookupById",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The id of the lookup to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. A Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. Either the request has missing/invalid values, or the response would exceed\nthe Lambda-safe payload size — in the latter case, retrieve versions individually via\nGetLookupVersionById instead.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}/lite": {
"get": {
"tags": [
"Lookup"
],
"summary": "Get lite lookup by ID with all versions",
"description": "\nThis method returns lite lookup with all versions
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupLiteById",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The id of the lookup to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "includeNotes",
"in": "query",
"description": "Indicates whether the result should contain versions with Notes field value included.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. A Lite Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLiteDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lite Lookup with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/versions": {
"post": {
"tags": [
"Lookup"
],
"summary": "Gets a list of versions",
"description": "\nThis endpoint returns a list of lookup versions from a received list of lookup ids paired with version numbers
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupsByIdsAndVersion",
"parameters": [
{
"name": "getActiveVersionIfNotFound",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByIdsAndVersionRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. A list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupVersionDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/names": {
"post": {
"tags": [
"Lookup"
],
"summary": "Gets a list of lookups and their active version from a list of names",
"description": "\nThis method returns a list of lookups with their active version from a list of Names
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupsByNames",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByNamesRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"202": {
"description": "Success. A list of Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}/version/{versionNumber}/file": {
"get": {
"tags": [
"Lookup"
],
"summary": "Retrieves a specific lookup version as a CSV file.",
"description": "
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupVersionFile",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The Id of the existing model",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "The version number to retrieve",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Returns the CSV file stream of the version of a lookup.",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "The request is invalid or the 'LookupVersion' is null.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "No Lookup version was found with the provided details.",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookup/{lookupId}/column-filter": {
"post": {
"tags": [
"Lookup"
],
"summary": "Get specific columns of an existing Lookup",
"description": "\nThis method returns the, specified by column names, metadata for a given Lookup Id
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLookupByIdWithColumnFilter",
"parameters": [
{
"name": "lookupId",
"in": "path",
"description": "The Id of the existing model",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LookupMetadataColumnsRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. A Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id/version does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Get all lookups and their parent child relationship.",
"description": "\nThis method returns all Linked Lookups for the client tenant
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLinkLookups",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Linked Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
},
"deprecated": true
}
},
"/api/lookuplink/active": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Gets all Link Lookups active version for the client tenant.",
"description": "\nThis method returns all Lookups with only the active for a given tenant
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllActiveLinkLookups",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Linked Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/lite": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Gets all Link Lookups (lite)",
"description": "\nThis method returns all Link Lookups for given tenant.\n This is lite endpoint and will not return the definitions of the values and signees.
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetAllLinkLookupsLite",
"parameters": [
{
"name": "includeNotes",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Link Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkLiteDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/{id}": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Get the current active version of an existing Link Lookup along with its relationships.",
"description": "\nThis method returns the active, currently in effect, published version for a given Linked Lookup
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLinkLookupById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the Linked Lookup to retrieve",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. Linked Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Linked Lookup with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/{id}/version/{versionNumber}": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Get the specified version of an existing Linked Lookup",
"description": "\nThis method returns the, specified by number, version for a given Linked Lookup
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLinkLookupVersionById",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the existing Linked Lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "The version number to retrieve",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. Linked Lookup is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkVersionDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Linked Lookup with given id/version does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/versions": {
"post": {
"tags": [
"LookupLink"
],
"summary": "Gets a list of versions",
"description": "\nThis endpoint returns a list of link lookup versions from a received list of lookup ids paired with version numbers
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLinkLookupsByIdsAndVersion",
"parameters": [
{
"name": "getActiveVersionIfNotFound",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "List of lookup links to find",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LinkLookupsByIdsAndVersionsRequestServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. A list of Link Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkVersionDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/lookup/{lookupid}": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Get all Linked Lookup version of a existing Lookup",
"description": "\nThis method returns a list of Linked Lookup version , associated to a lookup",
"operationId": "GetLinkLookupByLookup",
"parameters": [
{
"name": "lookupid",
"in": "path",
"description": "The id of the Lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of Linked Lookups is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LookupLinkVersionIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Lookup with given id/version does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal Server Error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/lookuplink/{linkLookupId}/version/{versionNumber}/file": {
"get": {
"tags": [
"LookupLink"
],
"summary": "Retrieves a specific lookup version as a CSV file.",
"description": "
Required permissions:
Following permissions are required: LookupAccess",
"operationId": "GetLinkLookupVersionFile",
"parameters": [
{
"name": "linkLookupId",
"in": "path",
"description": "The Id of the existing Linked Lookup",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "The version number to retrieve",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Returns the CSV file stream of the version of a lookup.",
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "The request is invalid or the 'LookupVersion' is null.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "No Lookup version was found with the provided details.",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Approver": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"IApprover": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true,
"readOnly": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"Int32ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "integer",
"format": "int32"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LinkLookupProperty": {
"type": "object",
"properties": {
"childValues": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"LinkLookupPropertyDto": {
"type": "object",
"properties": {
"childValues": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"LinkLookupsByIdsAndVersionsRequest": {
"type": "object",
"properties": {
"linkLookups": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "The dictionary that contains link lookup IDs and version numbers to find",
"nullable": true,
"example": {
"6b6de3e3-48b1-46a1-adb0-701653a61c2c": 1,
"6b6de3e3-48b2-46a1-adb0-701653a61c2c": 2,
"6b6de3e3-48b3-46a1-adb0-701653a61c2c": 3
}
}
},
"additionalProperties": false,
"description": "Object for querying Link Lookup data"
},
"LinkLookupsByIdsAndVersionsRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LinkLookupsByIdsAndVersionsRequest"
}
],
"description": "Object for querying Link Lookup data",
"nullable": true
}
},
"additionalProperties": false
},
"LookupDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Lookup Id",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"isSystemLookup": {
"type": "boolean",
"description": "Flag to display if this is a System Lookup",
"example": false
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupVersionDto"
},
"description": "List of available lookup versions",
"nullable": true
}
},
"additionalProperties": false,
"description": "Lookup Data"
},
"LookupDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupDto"
}
],
"description": "Lookup Data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupItemDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id of Item",
"nullable": true,
"example": "D64AA6E3-C4BB-45B4-95A6-F9FC07DD1958"
},
"value": {
"type": "string",
"description": "Value of Item",
"nullable": true,
"example": "Ireland"
}
},
"additionalProperties": false,
"description": "Defines column with metadata for lookup values"
},
"LookupLinkDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Lookup Link Id",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkVersionDto"
},
"description": "List of available lookup links versions",
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkLiteDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Lookup Link Id",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkVersionBaseDto"
},
"description": "List of available lookup links versions with basic details",
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkLiteDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkLiteDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkVersion": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"format": "int32"
},
"effectiveFrom": {
"type": "string",
"format": "date-time"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
]
},
"nextApprover": {
"allOf": [
{
"$ref": "#/components/schemas/IApprover"
}
],
"nullable": true,
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time"
},
"notes": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"lookupLinkId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"parentLookupId": {
"type": "string",
"format": "uuid"
},
"parentLookupVersion": {
"type": "integer",
"format": "int32"
},
"childLookupId": {
"type": "string",
"format": "uuid"
},
"childLookupVersion": {
"type": "integer",
"format": "int32"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/LinkLookupProperty"
},
"nullable": true
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"nullable": true
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IApprover"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"LookupLinkVersionBaseDto": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query",
"example": true
},
"id": {
"type": "string",
"description": "The UiD of the version",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"lookupLinkId": {
"type": "string",
"description": "The UiD of the Lookup Link that the version belongs to",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5152"
},
"name": {
"type": "string",
"description": "Display name of the Lookup Link",
"nullable": true,
"example": "Lookup1"
},
"parentLookupId": {
"type": "string",
"description": "Parent Lookup Id Linked",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5153"
},
"parentLookupVersion": {
"type": "integer",
"description": "Parent Lookup Version Linked",
"format": "int32",
"example": 1
},
"childLookupId": {
"type": "string",
"description": "Child Lookup Id Linked",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5154"
},
"childLookupVersion": {
"type": "integer",
"description": "Child Lookup Version Linked",
"format": "int32",
"example": 1
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
}
},
"additionalProperties": false
},
"LookupLinkVersionDto": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query",
"example": true
},
"id": {
"type": "string",
"description": "The UiD of the version",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"lookupLinkId": {
"type": "string",
"description": "The UiD of the Lookup Link that the version belongs to",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5152"
},
"name": {
"type": "string",
"description": "Display name of the Lookup Link",
"nullable": true,
"example": "Lookup1"
},
"parentLookupId": {
"type": "string",
"description": "Parent Lookup Id Linked",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5153"
},
"parentLookupVersion": {
"type": "integer",
"description": "Parent Lookup Version Linked",
"format": "int32",
"example": 1
},
"childLookupId": {
"type": "string",
"description": "Child Lookup Id Linked",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5154"
},
"childLookupVersion": {
"type": "integer",
"description": "Child Lookup Version Linked",
"format": "int32",
"example": 1
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/LinkLookupPropertyDto"
},
"description": "Dictionary of linked values parents to children",
"nullable": true
},
"propertiesOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ordered parent lookup values",
"nullable": true
},
"childValuesOrder": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of ordered child lookup values",
"nullable": true
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkVersionDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkVersionDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupLinkVersionDto"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLinkVersionIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLinkVersion"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the lookup",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"isSystemLookup": {
"type": "boolean",
"description": "Flag to display if this is a System Lookup",
"example": false
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLiteVersionDto"
},
"description": "List of available lookup versions",
"nullable": true
}
},
"additionalProperties": false,
"description": "Lookup Data"
},
"LookupLiteDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLiteDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteDtoItemsPage": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLiteDto"
},
"nullable": true
},
"paginationToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteDtoItemsPageServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupLiteDtoItemsPage"
}
],
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupLiteDto"
}
],
"description": "Lookup Data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteV2Dto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the lookup",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"isSystemLookup": {
"type": "boolean",
"description": "Flag to display if this is a System Lookup",
"example": false
},
"name": {
"type": "string",
"description": "Lookup Name",
"nullable": true,
"example": "Journey Type"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "Lookup active version status",
"nullable": true,
"example": "Status"
},
"activeVersionNumber": {
"type": "integer",
"description": "Lookup active version number",
"format": "int32",
"example": 6
},
"publicationDate": {
"type": "string",
"description": "The date that the active version got published",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLiteVersionDto"
},
"description": "List of available lookup versions",
"nullable": true
}
},
"additionalProperties": false,
"description": "Lookup Data"
},
"LookupLiteV2DtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupLiteV2Dto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupLiteVersionDto": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query",
"example": true
},
"id": {
"type": "string",
"description": "The UiD of the version",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"lookupId": {
"type": "string",
"description": "The UiD of the Lookup that the version belongs to",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5152"
},
"lookupName": {
"type": "string",
"description": "Display name of the model",
"nullable": true,
"example": "TestLookup"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"isSystemLookup": {
"type": "boolean",
"description": "Flag to display if is a System Lookup and is protect to be deleted or updated LookupName",
"example": false
}
},
"additionalProperties": false,
"description": "Instance of a Lookup Version."
},
"LookupMetadataColumnsRequest": {
"type": "object",
"properties": {
"columnNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Column names list for searched lookups",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object for querying Lookup data"
},
"LookupMetadataColumnsRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupMetadataColumnsRequest"
}
],
"description": "Object for querying Lookup data",
"nullable": true
}
},
"additionalProperties": false
},
"LookupVersionDto": {
"type": "object",
"properties": {
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Draft"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query",
"example": true
},
"id": {
"type": "string",
"description": "The UiD of the version",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5151"
},
"lookupId": {
"type": "string",
"description": "The UiD of the Lookup that the version belongs to",
"format": "uuid",
"example": "e1809731-77df-4e72-98e7-0d314b7a5152"
},
"lookupName": {
"type": "string",
"description": "Display name of the model",
"nullable": true,
"example": "TestLookup"
},
"notes": {
"type": "string",
"description": "Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term.",
"nullable": true,
"example": "Example Notes"
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-12-12T15:55:00.000Z"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-12-12T15:55:00.000Z"
},
"isSystemLookup": {
"type": "boolean",
"description": "Flag to display if is a System Lookup and is protect to be deleted or updated LookupName",
"example": false
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of values for lookup",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupItemDto"
},
"description": "List of reference values for lookup",
"nullable": true
},
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Signee"
},
"description": "The defined list of signees for the version",
"nullable": true
},
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MetadataColumnDto"
},
"description": "Lookup metadata column collection",
"nullable": true
}
},
"additionalProperties": false,
"description": "Instance of a Lookup Version."
},
"LookupVersionDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LookupVersionDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupVersionDto"
}
],
"description": "Instance of a Lookup Version.",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"LookupsByIdsAndVersionRequest": {
"type": "object",
"properties": {
"lookups": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int32"
},
"description": "The dictionary that contains lookup IDs and version numbers to find",
"nullable": true,
"example": {
"6b6de3e3-48b1-46a1-adb0-701653a61c2c": 1,
"6b6de3e3-48b2-46a1-adb0-701653a61c2c": 2,
"6b6de3e3-48b3-46a1-adb0-701653a61c2c": 3
}
}
},
"additionalProperties": false,
"description": "Object for querying Lookup data"
},
"LookupsByIdsAndVersionRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByIdsAndVersionRequest"
}
],
"description": "Object for querying Lookup data",
"nullable": true
}
},
"additionalProperties": false
},
"LookupsByIdsRequest": {
"type": "object",
"properties": {
"lookupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Id list for searched lookups",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object for querying Lookup data"
},
"LookupsByIdsRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByIdsRequest"
}
],
"description": "Object for querying Lookup data",
"nullable": true
}
},
"additionalProperties": false
},
"LookupsByNamesRequest": {
"type": "object",
"properties": {
"lookupNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Name list for searched lookups",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object for querying Lookup data"
},
"LookupsByNamesRequestServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/LookupsByNamesRequest"
}
],
"description": "Object for querying Lookup data",
"nullable": true
}
},
"additionalProperties": false
},
"MetadataColumnDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of column",
"nullable": true,
"example": "text"
},
"name": {
"type": "string",
"description": "Name of column",
"nullable": true,
"example": "Text name"
},
"values": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/MetadataColumnValueDto"
},
"description": "Column values - key is lookup value",
"nullable": true
}
},
"additionalProperties": false,
"description": "Defines column with metadata for lookup values"
},
"MetadataColumnValueDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Value of lookup value's column entry",
"nullable": true,
"example": "Test value"
}
},
"additionalProperties": false,
"description": "Defines value of lookup value's column entry"
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Signee": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ValidationErrorModel": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"attemptedValue": {
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationErrorModelListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorModel"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false,
"example": {
"data": [
{
"propertyName": "data",
"errorMessage": "Data is required",
"attemptedValue": "",
"errorCode": "NotNullValidator"
}
],
"messages": [
{
"message": "Data is required",
"type": "Error",
"errorCode": "Error Code"
}
]
}
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}