{ "openapi": "3.0.0", "info": { "title": "LogChain API", "version": "0.0.1" }, "paths": { "/additional-information/create": { "post": { "x-controller-name": "AdditionalInformationController", "x-operation-name": "create", "tags": [ "AdditionalInformationController" ], "responses": { "200": { "description": "Return value of AdditionalInformationController.create" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdditionalInformationController.create" } }, "/additional-information/latest-by-pmos": { "post": { "x-controller-name": "AdditionalInformationController", "x-operation-name": "latestByPmos", "tags": [ "AdditionalInformationController" ], "responses": { "200": { "description": "Return value of AdditionalInformationController.latestByPmos" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdditionalInformationController.latestByPmos" } }, "/additional-information/save-draft": { "post": { "x-controller-name": "AdditionalInformationController", "x-operation-name": "upsert", "tags": [ "AdditionalInformationController" ], "responses": { "200": { "description": "Return value of AdditionalInformationController.upsert" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdditionalInformationController.upsert" } }, "/additional-information/{pmoId}/{status}": { "get": { "x-controller-name": "AdditionalInformationController", "x-operation-name": "getAdditionalInformation", "tags": [ "AdditionalInformationController" ], "responses": { "200": { "description": "Return value of AdditionalInformationController.getAdditionalInformation" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "status", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdditionalInformationController.getAdditionalInformation" } }, "/admin/categories/{id}": { "patch": { "x-controller-name": "CategoryPrivateController", "x-operation-name": "updateById", "tags": [ "Category" ], "responses": { "204": { "description": "Category PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "CategoryPrivateController.updateById" }, "get": { "x-controller-name": "CategoryPrivateController", "x-operation-name": "findById", "tags": [ "Category" ], "responses": { "200": { "description": "Category model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CategoryPrivateController.findById" }, "delete": { "x-controller-name": "CategoryPrivateController", "x-operation-name": "deleteById", "tags": [ "Category" ], "responses": { "204": { "description": "Category DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CategoryPrivateController.deleteById" } }, "/admin/categories": { "post": { "x-controller-name": "CategoryPrivateController", "x-operation-name": "create", "tags": [ "Category" ], "responses": { "200": { "description": "Create new company party" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "default": "", "description": "Category name", "example": "category_name" }, "description": { "type": "string", "default": "" }, "type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 0 }, "type_detail": { "type": "array", "items": { "type": "number", "default": [] } }, "granted_users": { "type": "array", "items": { "type": "number", "default": [] } }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1 } } } } }, "description": "The request body for creating category." }, "operationId": "CategoryPrivateController.create" }, "get": { "x-controller-name": "CategoryPrivateController", "x-operation-name": "find", "tags": [ "Category" ], "responses": { "200": { "description": "Array of Category records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Category.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CategoryPrivateController.find" } }, "/admin/companies/licence": { "post": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "createOrUpdateLicence", "tags": [ "Company" ], "responses": { "200": { "description": "Create new company licence" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLicenceDto" } } } }, "operationId": "CompanyPrivateController.createOrUpdateLicence" } }, "/admin/companies/{id}/regulatory-histories": { "get": { "x-controller-name": "CompanyRegulatoryPrivateController", "x-operation-name": "findCompanyRegulatoryHistories", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "Array of CompanyRegulatoryHistories records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRegulatoryHistoriesDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRegulatory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyRegulatoryPrivateController.findCompanyRegulatoryHistories" } }, "/admin/companies/{id}": { "patch": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "updateById", "tags": [ "Company" ], "responses": { "204": { "description": "Company PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoPartialExcluding_main_contact_id-parent_company_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "CompanyPrivateController.updateById" }, "get": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "findById", "tags": [ "Company" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "logo": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string" }, "privacy_status": { "type": "boolean" }, "status": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "main_contact": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "contact_email": { "type": "string" } } }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "users": { "type": "object", "properties": { "active": { "type": "number" }, "inactive": { "type": "number" }, "invite": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "locations": { "type": "array", "items": { "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } } } } } } } }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyPrivateController.findById" }, "delete": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "deleteById", "tags": [ "Company" ], "responses": { "204": { "description": "Company DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyPrivateController.deleteById" } }, "/admin/companies": { "post": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "create", "tags": [ "Company" ], "responses": { "200": { "description": "The ID of new Company", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompany" } } } }, "operationId": "CompanyPrivateController.create" }, "get": { "x-controller-name": "CompanyPrivateController", "x-operation-name": "find", "tags": [ "Company" ], "responses": { "200": { "description": "Array of Company records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "logo": { "type": "string" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string" }, "privacy_status": { "type": "boolean" }, "status": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "users": { "type": "object", "properties": { "active": { "type": "number" }, "inactive": { "type": "number" }, "invite": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" } } } }, "licences": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "number" }, "rate": { "type": "number" }, "start_date": { "type": "date-time" }, "end_date": { "type": "date-time" }, "modifier": { "type": "string" }, "modifier_company": { "type": "string" } } } }, "privacy_status_name": { "type": "string" }, "status_name": { "type": "string" }, "timezone": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } }, { "description": "The provider persona id to query: \n* `1` - Consignee \n* `2` - ISO Tank Depot \n* `3` - Logistics Service Provider \n* `4` - Port \n* `5` - Railhead \n* `6` - Shipper \n* `7` - Shipping Line \n* `8` - Trucking Company \n* `9` - Log Chain \n* `10` - Agent \n* `11` - Bulk Storage Terminal \n", "required": false, "name": "persona", "in": "query", "schema": { "type": "integer", "enum": [ 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8 ] } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyPrivateController.find" } }, "/admin/companies-regulatory/{id}": { "patch": { "x-controller-name": "CompanyRegulatoryPrivateController", "x-operation-name": "updateById", "tags": [ "Company Regulatory" ], "responses": { "204": { "description": "CompanyRegulatory PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "duration_start": { "type": "string", "format": "date-time" }, "duration_end": { "type": "string", "format": "date-time", "formatMinimum": { "$data": "1/duration_start" } }, "status": { "type": "number", "enum": [ 2, 3, 4 ] }, "comment": { "type": "string", "maxLength": 300 } }, "allOf": [ { "if": { "properties": { "status": { "const": 3 } } }, "then": { "required": [ "comment" ] } }, { "if": { "properties": { "status": { "const": 4 } } }, "then": { "required": [ "duration_start", "duration_end" ] } } ] } } }, "x-parameter-index": 1 }, "operationId": "CompanyRegulatoryPrivateController.updateById" }, "get": { "x-controller-name": "CompanyRegulatoryPrivateController", "x-operation-name": "findById", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "CompanyRegulatory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyRegulatoryDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyRegulatoryPrivateController.findById" } }, "/admin/companies-regulatory": { "get": { "x-controller-name": "CompanyRegulatoryPrivateController", "x-operation-name": "find", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "Array of CompanyRegulatory records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRegulatoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRegulatory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyRegulatoryPrivateController.find" } }, "/admin/flows-default/{id}/groups": { "put": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "upsertGroup", "tags": [ "Flow Default" ], "responses": { "200": { "description": "The ID of groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Group PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "groups" ], "properties": { "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true, "minItems": 1 }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the group.", "x-parameter-index": 1 }, "operationId": "FlowDefaultPrivateController.upsertGroup" } }, "/admin/flows-default/{id}/personas": { "put": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "upsertPersona", "tags": [ "Flow Default" ], "responses": { "200": { "description": "The ID of reference personas", "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_personas": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Reference personas PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ref_personas" ], "properties": { "ref_personas": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "persona_id", "name" ], "properties": { "name": { "type": "string" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 1 }, "operationId": "FlowDefaultPrivateController.upsertPersona" } }, "/admin/flows-default/{id}/steps/{step_id}": { "put": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "upsertStepDetails", "tags": [ "Flow Default" ], "responses": { "200": { "description": "The ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 2 }, "operationId": "FlowDefaultPrivateController.upsertStepDetails" } }, "/admin/flows-default/{id}/steps": { "put": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "upsertStep", "tags": [ "Flow Default" ], "responses": { "200": { "description": "The array ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "name", "persona_id", "order", "flow_persona_id" ], "properties": { "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the step", "x-parameter-index": 1 }, "operationId": "FlowDefaultPrivateController.upsertStep" } }, "/admin/flows-default/{id}": { "get": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "findById", "tags": [ "Flow Default" ], "responses": { "200": { "description": "FlowDefault model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" } } }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "identifier": { "type": "string" } } }, "description": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "journey_points": { "type": "array", "items": { "type": "string" } }, "group_personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" } } } } } } }, "journey_points": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "persona_id": { "type": "number" } } } }, "journey_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_default_form": { "type": "object", "properties": { "name": { "type": "string" }, "from_id": { "type": "string" } } }, "flow_default_personas": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "journey_consensus": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_default_personas": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "step_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "group_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "r_journey", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FlowDefaultPrivateController.findById" }, "delete": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "deleteById", "tags": [ "Flow Default" ], "responses": { "204": { "description": "Default flow DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowDefaultPrivateController.deleteById" } }, "/admin/flows-default": { "put": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "upsertFlow", "tags": [ "Flow Default" ], "responses": { "200": { "description": "The ID of new flows", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } }, "204": { "description": "The flow PUT success" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFlowDefault1" } } } }, "operationId": "FlowDefaultPrivateController.upsertFlow" }, "get": { "x-controller-name": "FlowDefaultPrivateController", "x-operation-name": "find", "tags": [ "Flow Default" ], "responses": { "200": { "description": "Array of FlowDefault records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" } } }, "company_access": { "type": "number" }, "company_access_name": { "type": "string" }, "stats": { "type": "object", "properties": { "groups": { "type": "number" }, "steps": { "type": "number" }, "personas": { "type": "number" } } }, "name": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FlowDefault.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowDefaultPrivateController.find" } }, "/admin/regulatory-declarations/dashboard": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "calcStatisticDeclaration", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Statistic of regulatory declaration" } }, "parameters": [ { "description": "The company id.", "required": false, "name": "company", "in": "query", "schema": { "type": "number" } } ], "operationId": "RegulatoryDeclarationsPrivateController.calcStatisticDeclaration" } }, "/admin/regulatory-declarations/{id}/invoices": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "findInvoices", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The list of invoices" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryInvoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsPrivateController.findInvoices" } }, "/admin/regulatory-declarations/{id}/items": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "findItems", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The list of items" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryItems.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsPrivateController.findItems" } }, "/admin/regulatory-declarations/{id}/submissions": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "findHistorySubmissions", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "List histories submissions" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatorySubmissionHistories.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsPrivateController.findHistorySubmissions" } }, "/admin/regulatory-declarations/{id}": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "findById", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "RegulatoryDeclarations model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryDeclarationsDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsPrivateController.findById" } }, "/admin/regulatory-declarations": { "get": { "x-controller-name": "RegulatoryDeclarationsPrivateController", "x-operation-name": "find", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Array of RegulatoryDeclarations records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryDeclarationsDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryDeclarations.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RegulatoryDeclarationsPrivateController.find" } }, "/admin/roles/features": { "get": { "x-controller-name": "RolePrivateController", "x-operation-name": "findFeatures", "tags": [ "Role" ], "responses": { "200": { "description": "Array of Module records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModuleDtoExcluding_access-description_" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Feature.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RolePrivateController.findFeatures" } }, "/admin/roles/{id}": { "patch": { "x-controller-name": "RolePrivateController", "x-operation-name": "updateById", "tags": [ "Role" ], "responses": { "204": { "description": "Role PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDtoPartialExcluding_user_count-user_active-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "RolePrivateController.updateById" }, "get": { "x-controller-name": "RolePrivateController", "x-operation-name": "findById", "tags": [ "Role" ], "responses": { "200": { "description": "Role model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RolePrivateController.findById" }, "delete": { "x-controller-name": "RolePrivateController", "x-operation-name": "deleteById", "tags": [ "Role" ], "responses": { "204": { "description": "Role DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RolePrivateController.deleteById" } }, "/admin/roles": { "post": { "x-controller-name": "RolePrivateController", "x-operation-name": "create", "tags": [ "Role" ], "responses": { "200": { "description": "The ID of new Role", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRole2" } } } }, "operationId": "RolePrivateController.create" }, "get": { "x-controller-name": "RolePrivateController", "x-operation-name": "find", "tags": [ "Role" ], "responses": { "200": { "description": "Array of Role records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Role.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RolePrivateController.find" } }, "/admin/trade-lanes/{id}/copy": { "post": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "copy", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "The data of copied trade-lane" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TradeLanePrivateController.copy" } }, "/admin/trade-lanes/{id}/flow": { "put": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "upsertFlow", "tags": [ "Trade Lane" ], "responses": { "200": { "204": { "description": "Reference Flow PUT success" }, "description": "The ID of reference flow", "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_flow": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "personas", "journey_points" ], "properties": { "personas": { "type": "array", "items": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } } }, "journey_points": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "order": { "type": "number" }, "persona": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "order": { "type": "number" } } }, "actor": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } }, "name": { "type": "string", "maxLength": 100 }, "expected_date_info": { "type": "object", "required": [ "field_name", "adjustment" ], "properties": { "field_name": { "type": "string" }, "adjustment": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } } }, "validator": { "type": "object", "nullable": true, "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } }, "actions": { "type": "array", "items": { "type": "object", "required": [ "form_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" } } } } } } }, "flow_status": { "type": "boolean", "default": false } } } } }, "description": "The request body for create or update the TradeLaneFlow.", "x-parameter-index": 1 }, "operationId": "TradeLanePrivateController.upsertFlow" } }, "/admin/trade-lanes/{id}": { "patch": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "updateById", "tags": [ "Trade Lane" ], "responses": { "204": { "description": "TradeLane PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "TradeLanePrivateController.updateById" }, "get": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "findById", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "TradeLane model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "trade_lane_flow": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "personas": { "type": "array", "items": { "type": "object" } }, "journey_points": { "type": "array", "items": { "type": "object" } } } }, "flow_status": { "type": "boolean" }, "product": { "type": "string" }, "product_no": { "type": "string" }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string" }, "desired_temp": { "type": "number" }, "safety_data_sheet": { "type": "string" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string" }, "provisions": { "type": "string" }, "status": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "flows": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "number" }, "stats": { "type": "object", "properties": { "steps": { "type": "number" } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TradeLanePrivateController.findById" }, "delete": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "deleteById", "tags": [ "Trade Lane" ], "responses": { "204": { "description": "TradeLane DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TradeLanePrivateController.deleteById" } }, "/admin/trade-lanes": { "post": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "create", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "The ID of new TradeLane", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTradeLaneDtoWithCompanyId" } } } }, "operationId": "TradeLanePrivateController.create" }, "get": { "x-controller-name": "TradeLanePrivateController", "x-operation-name": "find", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "Array of TradeLane records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "persona": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" } } }, "journey_points": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "persona_id": { "type": "number" } } } }, "product": { "type": "string" }, "product_no": { "type": "string" }, "safety_data_sheet": { "type": "string" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string" }, "provisions": { "type": "string" }, "status": { "type": "boolean" }, "status_name": { "type": "boolean" }, "default_flow": { "type": "number" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TradeLane.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } } ], "operationId": "TradeLanePrivateController.find" } }, "/admin/users/filters/companies": { "get": { "x-controller-name": "UserPrivateController", "x-operation-name": "findFiltersCompanys", "tags": [ "User" ], "responses": { "200": { "description": "Array of CompanyFilter records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFilterDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserPrivateController.findFiltersCompanys" } }, "/admin/users/filters/roles": { "get": { "x-controller-name": "UserPrivateController", "x-operation-name": "findFiltersRoles", "tags": [ "User" ], "responses": { "200": { "description": "Array of RoleFilter records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoleFilterDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Role.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserPrivateController.findFiltersRoles" } }, "/admin/users/resend-initial-password": { "post": { "x-controller-name": "UserPrivateController", "x-operation-name": "resendTemporaryPassword", "tags": [ "User" ], "responses": { "200": { "description": "Resend initial password" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string" } } } } } }, "operationId": "UserPrivateController.resendTemporaryPassword" } }, "/admin/users/{id}": { "patch": { "x-controller-name": "UserPrivateController", "x-operation-name": "updateById", "tags": [ "User" ], "responses": { "204": { "description": "User PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "UserPrivateController.updateById" }, "get": { "x-controller-name": "UserPrivateController", "x-operation-name": "findById", "tags": [ "User" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" } } }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "avatar": { "type": "string" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_admin_name": { "type": "string" }, "blockchain_status": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "login_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "table_name": { "type": "string" }, "feature_id": { "type": "string" }, "description": { "type": "string" }, "activity_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "UserPrivateController.findById" }, "delete": { "x-controller-name": "UserPrivateController", "x-operation-name": "deleteById", "tags": [ "User" ], "responses": { "204": { "description": "User DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "UserPrivateController.deleteById" } }, "/admin/users": { "post": { "x-controller-name": "UserPrivateController", "x-operation-name": "create", "tags": [ "User" ], "responses": { "200": { "description": "The ID of new User", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserWithCompanyId" } } } }, "operationId": "UserPrivateController.create" }, "get": { "x-controller-name": "UserPrivateController", "x-operation-name": "find", "tags": [ "User" ], "responses": { "200": { "description": "Array of User records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "avatar": { "type": "string" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_admin_name": { "type": "string" }, "blockchain_status": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "login_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserPrivateController.find" } }, "/ap-calendar/import": { "post": { "x-controller-name": "ApCalendarController", "x-operation-name": "importApCalendar", "tags": [ "ApCalendarController" ], "responses": { "200": { "description": "Return value of ApCalendarController.importApCalendar" } }, "operationId": "ApCalendarController.importApCalendar" } }, "/ap-calendar/run-import-cronjob": { "post": { "x-controller-name": "ApCalendarController", "x-operation-name": "runImportCronJob", "tags": [ "ApCalendarController" ], "responses": { "200": { "description": "Return value of ApCalendarController.runImportCronJob" } }, "operationId": "ApCalendarController.runImportCronJob" } }, "/api/charts/activity-feed": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "activityFeed", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Today Activity Feed" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "DashboardController.activityFeed" } }, "/api/charts/drops-pickups": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "dropsPickups", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Drops vs Pickups chart data" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "group_by", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.dropsPickups" } }, "/api/charts/dwell-time-sparkline": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "dwellTimeSparkline", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Avg warehouse dwell time sparkline — AP-aligned window" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.dwellTimeSparkline" } }, "/api/charts/pending-shipment-no": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "pendingShipmentNo", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Pending shipment temporary numbers with AP-week trend" } }, "parameters": [ { "name": "trend_window", "in": "query", "required": false, "description": "Trend grouping. Currently supported: ap_weeks.", "schema": { "type": "string", "enum": [ "ap_weeks" ], "default": "ap_weeks" } }, { "name": "ap_code", "in": "query", "required": false, "description": "AP period code (e.g. AP05-2026). Defaults to the current AP period.", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.pendingShipmentNo" } }, "/api/charts/pickups-by-provider": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "pickupsByProvider", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Pickups by provider with pending-sync breakdown" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.pickupsByProvider" } }, "/api/charts/rejection-reasons": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "rejectionReasons", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Rejection reasons breakdown chart" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.rejectionReasons" } }, "/api/charts/sla-compliance": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "slaCompliance", "tags": [ "DashboardController" ], "responses": { "200": { "description": "SLA Compliance Gauge data" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.slaCompliance" } }, "/api/charts/status-breakdown": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "statusBreakdown", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Shipment status breakdown chart" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.statusBreakdown" } }, "/api/charts/volume-heatmap": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "volumeHeatmap", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Daily PMO volume heatmap — current AP period" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.volumeHeatmap" } }, "/api/export/dashboard-excel": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "exportDashboardExcel", "tags": [ "DashboardController" ], "responses": { "200": { "description": "LogChain PMO Dashboard — Excel export (all sheets)", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {} } } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.exportDashboardExcel" } }, "/api/flags": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "flags", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Active flags panel — breach and risk PMOs" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.flags" } }, "/api/kpi/active-pmos": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "activePmos", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Active PMO count with nearing-SLA at-risk list" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.activePmos" } }, "/api/kpi/avg-dwell": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "avgDwell", "tags": [ "DashboardController" ], "responses": { "200": { "description": "Average dwell KPI" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.avgDwell" } }, "/api/kpi/current-ap-period": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "currentApPeriod", "tags": [ "DashboardController" ], "responses": { "200": { "description": "AP period label matching selected filter" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.currentApPeriod" } }, "/api/kpi/sla-breaches": { "get": { "x-controller-name": "DashboardController", "x-operation-name": "slaBreaches", "tags": [ "DashboardController" ], "responses": { "200": { "description": "SLA Breaches KPI — real-time open breach count" } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "DashboardController.slaBreaches" } }, "/attachments/pmo/{pmoId}/by-type": { "get": { "x-controller-name": "AttachmentController", "x-operation-name": "getByPmoAndType", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.getByPmoAndType" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "AttachmentController.getByPmoAndType" } }, "/attachments/pmo/{pmoId}": { "get": { "x-controller-name": "AttachmentController", "x-operation-name": "getByPmo", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.getByPmo" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AttachmentController.getByPmo" } }, "/attachments/upload": { "put": { "x-controller-name": "AttachmentController", "x-operation-name": "uploadAttachment", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.uploadAttachment" } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "pmoIds", "in": "query", "schema": { "type": "string" } } ], "operationId": "AttachmentController.uploadAttachment" } }, "/attachments/{id}/group": { "delete": { "x-controller-name": "AttachmentController", "x-operation-name": "deleteAttachmentGroup", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.deleteAttachmentGroup" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pmoIds": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "AttachmentController.deleteAttachmentGroup" } }, "/attachments/{id}/view": { "get": { "x-controller-name": "AttachmentController", "x-operation-name": "viewAttachment", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.viewAttachment" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "t", "in": "query", "schema": { "type": "string" } } ], "operationId": "AttachmentController.viewAttachment" } }, "/attachments/{id}": { "delete": { "x-controller-name": "AttachmentController", "x-operation-name": "deleteAttachment", "tags": [ "AttachmentController" ], "responses": { "200": { "description": "Return value of AttachmentController.deleteAttachment" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AttachmentController.deleteAttachment" } }, "/auth/activate-user": { "post": { "x-controller-name": "AuthController", "x-operation-name": "activateUser", "tags": [ "AuthController" ], "responses": { "200": { "description": "User activated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "401": { "description": "Invalid or missing Cognito token" } }, "parameters": [ { "name": "authorization", "in": "header", "schema": { "type": "string" } } ], "operationId": "AuthController.activateUser" } }, "/auth/exchange-rfid-session": { "post": { "x-controller-name": "AuthController", "x-operation-name": "exchangeRFIDSession", "tags": [ "AuthController" ], "responses": { "200": { "description": "Return value of AuthController.exchangeRFIDSession" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuthController.exchangeRFIDSession" } }, "/auth/forgot-password": { "post": { "x-controller-name": "AuthController", "x-operation-name": "forgotPassword", "tags": [ "AuthController" ], "responses": { "200": { "description": "Return value of AuthController.forgotPassword" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuthController.forgotPassword" } }, "/auth/microsoft-login": { "post": { "x-controller-name": "AuthController", "x-operation-name": "microsoftLogin", "tags": [ "AuthController" ], "responses": { "200": { "description": "Microsoft login" } }, "parameters": [ { "name": "authorization", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AuthController.microsoftLogin" } }, "/auth/rfid-login": { "post": { "x-controller-name": "AuthController", "x-operation-name": "rfidLogin", "tags": [ "AuthController" ], "responses": { "200": { "description": "RFID login" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuthController.rfidLogin" } }, "/aws/webhook": { "post": { "x-controller-name": "AWSController", "x-operation-name": "get", "tags": [ "Aws" ], "responses": { "204": { "description": "Update status successfully." } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sub": { "type": "string" }, "company_id": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "AWSController.get" } }, "/bols/{id}/override": { "post": { "x-controller-name": "BolController", "x-operation-name": "override", "tags": [ "Bol" ], "responses": { "200": { "description": "The ID of new Bol", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "shipper": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "consignee": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "forwarding_agent": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "bol_no": { "type": "number" }, "place_of_issuance": { "type": "string" }, "booking_ref": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" }, "field_name": { "type": "string" }, "s3_key": { "type": "string" }, "external_id": { "type": "number" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "BolController.override" } }, "/bols/{id}": { "patch": { "x-controller-name": "BolController", "x-operation-name": "updateById", "tags": [ "Bol" ], "responses": { "204": { "description": "Bol PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BolDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-shipper_id-consignee_id-forwarding_agent_id-system_actual_date-company_identifier-expected_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "BolController.updateById" }, "get": { "x-controller-name": "BolController", "x-operation-name": "findById", "tags": [ "Bol" ], "responses": { "200": { "description": "Bol model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "shipper": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "consignee": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "forwarding_agent": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "bol_no": { "type": "number" }, "place_of_issuance": { "type": "string" }, "booking_ref": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" }, "field_name": { "type": "string" }, "s3_key": { "type": "string" }, "external_id": { "type": "number" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "BolController.findById" } }, "/bols": { "get": { "x-controller-name": "BolController", "x-operation-name": "find", "tags": [ "Bol" ], "responses": { "200": { "description": "Array of Bol records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "shipper": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "consignee": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "forwarding_agent": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "bol_no": { "type": "number" }, "place_of_issuance": { "type": "string" }, "booking_ref": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Bol.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BolController.find" } }, "/box/create": { "post": { "x-controller-name": "BoxController", "x-operation-name": "createBox", "tags": [ "BoxController" ], "responses": { "200": { "description": "Return value of BoxController.createBox" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BoxController.createBox" } }, "/box/delete": { "post": { "x-controller-name": "BoxController", "x-operation-name": "deleteBox", "tags": [ "BoxController" ], "responses": { "200": { "description": "Return value of BoxController.deleteBox" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BoxController.deleteBox" } }, "/box/pmo/{pmoId}": { "get": { "x-controller-name": "BoxController", "x-operation-name": "findByPMOId", "tags": [ "BoxController" ], "responses": { "200": { "description": "Return value of BoxController.findByPMOId" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BoxController.findByPMOId" } }, "/cargo-types": { "get": { "x-controller-name": "CargoTypeController", "x-operation-name": "find", "tags": [ "CargoType" ], "responses": { "200": { "description": "Array of CargoType records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CargoTypeDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CargoType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CargoTypeController.find" } }, "/cargoes/{id}/override": { "post": { "x-controller-name": "CargoController", "x-operation-name": "override", "tags": [ "Cargo" ], "responses": { "200": { "description": "The ID of new Cargo", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "containers": { "type": "array", "items": { "type": "object", "properties": { "container_no": { "type": "string" }, "shipment": { "type": "string" }, "reference": { "type": "string" } } } }, "allowed_containers": { "type": "array", "items": { "type": "string" } }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CargoController.override" } }, "/cargoes/{id}/validate": { "patch": { "x-controller-name": "CargoController", "x-operation-name": "validate", "tags": [ "Cargo" ], "responses": { "200": { "description": "Add more files to Cargo" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "CargoController.validate" } }, "/cargoes/{id}": { "patch": { "x-controller-name": "CargoController", "x-operation-name": "updateById", "tags": [ "Cargo" ], "responses": { "204": { "description": "Cargo PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "CargoController.updateById" }, "get": { "x-controller-name": "CargoController", "x-operation-name": "findById", "tags": [ "Cargo" ], "responses": { "200": { "description": "Cargo model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "containers": { "type": "array", "items": { "type": "object", "properties": { "container_no": { "type": "string" }, "shipment": { "type": "string" }, "reference": { "type": "string" } } } }, "allowed_containers": { "type": "array", "items": { "type": "string" } }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CargoController.findById" } }, "/cargoes": { "get": { "x-controller-name": "CargoController", "x-operation-name": "find", "tags": [ "Cargo" ], "responses": { "200": { "description": "Array of Cargo records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cargo.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CargoController.find" } }, "/categories/{flow_id}/available": { "get": { "x-controller-name": "CategoryController", "x-operation-name": "getAvailable", "tags": [ "Category" ], "responses": { "200": { "description": "Array of Category records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Category.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "flow_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CategoryController.getAvailable" } }, "/categories/{id}": { "get": { "x-controller-name": "CategoryController", "x-operation-name": "findById", "tags": [ "Category" ], "responses": { "200": { "description": "Category model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CategoryController.findById" } }, "/categories": { "get": { "x-controller-name": "CategoryController", "x-operation-name": "find", "tags": [ "Category" ], "responses": { "200": { "description": "Array of Category records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Category.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CategoryController.find" } }, "/checklist-config": { "get": { "x-controller-name": "ChecklistConfigController", "x-operation-name": "getByStatus", "tags": [ "ChecklistConfigController" ], "responses": { "200": { "description": "Return value of ChecklistConfigController.getByStatus" } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "number" } } ], "operationId": "ChecklistConfigController.getByStatus" } }, "/collar-types": { "get": { "x-controller-name": "CollarTypeController", "x-operation-name": "find", "tags": [ "CollarType" ], "responses": { "200": { "description": "Array of CollarType records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollarTypeDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CollarType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CollarTypeController.find" } }, "/companies/info": { "patch": { "x-controller-name": "CompanyController", "x-operation-name": "updateInfoByIdentifier", "tags": [ "Company" ], "responses": { "204": { "description": "Companies PATCH success" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoPartialExcluding_main_contact_id-status-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } } }, "operationId": "CompanyController.updateInfoByIdentifier" } }, "/companies/licence/{referred_company_id}": { "delete": { "x-controller-name": "CompanyController", "x-operation-name": "removeCompanyReferredLicence", "tags": [ "Company" ], "responses": { "200": { "description": "Remove company referred licence by id" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "parameters": [ { "name": "referred_company_id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyController.removeCompanyReferredLicence" } }, "/companies/licences": { "post": { "x-controller-name": "CompanyController", "x-operation-name": "createOrUpdateLicences", "tags": [ "Company" ], "responses": { "200": { "description": "Create new company licences in bulk" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "company_id", "referrer_company_id", "white_collar_users", "blue_collar_users" ], "properties": { "company_id": { "type": "number" }, "referrer_company_id": { "type": "number" }, "white_collar_users": { "type": "number" }, "blue_collar_users": { "type": "number" } } } } } }, "description": "The request body for create or update the CompanyLicences." }, "operationId": "CompanyController.createOrUpdateLicences" } }, "/companies/locations/{location_id}": { "delete": { "x-controller-name": "CompanyController", "x-operation-name": "deleteLocation", "tags": [ "Company" ], "responses": { "204": { "description": "Location DELETE success" } }, "parameters": [ { "name": "location_id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompanyController.deleteLocation" } }, "/companies/locations": { "put": { "x-controller-name": "CompanyController", "x-operation-name": "upsertLocation", "tags": [ "Company" ], "responses": { "204": { "description": "Companies PUT success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocation" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "locations": { "type": "array", "minItems": 1, "items": { "type": "object", "anyOf": [ { "type": "object", "required": [ "name", "address", "country_id", "persona_id", "google_map_link", "timezone", "status" ], "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "persona_id": { "type": "number" }, "google_map_link": { "type": "string" }, "timezone": { "type": "string" }, "status": { "type": "boolean", "default": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "persona_id": { "type": "number" }, "google_map_link": { "type": "string" }, "timezone": { "type": "string" }, "status": { "type": "boolean", "default": true } } } ] } } } } } } }, "operationId": "CompanyController.upsertLocation" }, "get": { "x-controller-name": "CompanyController", "x-operation-name": "findLocations", "tags": [ "Company" ], "responses": { "200": { "description": "All locations of the current company", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyLocation" } } } } }, "operationId": "CompanyController.findLocations" } }, "/companies/{identifier}": { "get": { "x-controller-name": "CompanyController", "x-operation-name": "findByIdentifier", "tags": [ "Company" ], "responses": { "200": { "description": "Company model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "logo": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string" }, "privacy_status": { "type": "boolean" }, "status": { "type": "number" }, "main_contact": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "contact_email": { "type": "string" } } }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "users": { "type": "object", "properties": { "active": { "type": "number" }, "inactive": { "type": "number" }, "invite": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "locations": { "type": "array", "items": { "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } } } } } } } }, "privacy_status_name": { "type": "string" }, "status_name": { "type": "string" }, "timezone": { "type": "string" } } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CompanyController.findByIdentifier" } }, "/companies": { "post": { "x-controller-name": "CompanyController", "x-operation-name": "create", "tags": [ "Company" ], "responses": { "201": { "description": "Companies POST success", "content": { "description": "Array of CompanyCreatedFromCompanyAdmin records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCreatedFromCompanyAdminDto", "definitions": { "CompanyCreatedFromCompanyAdminDto": { "$ref": "#/components/schemas/CompanyCreatedFromCompanyAdminDto" } } } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPublicCreateDtoExcluding_id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } } }, "operationId": "CompanyController.create" }, "get": { "x-controller-name": "CompanyController", "x-operation-name": "find", "tags": [ "Company" ], "responses": { "200": { "description": "Array of Company records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "logo": { "type": "string" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "users": { "type": "object", "properties": { "active": { "type": "number" }, "inactive": { "type": "number" }, "invite": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" } } } }, "privacy_status_name": { "type": "string" }, "status_name": { "type": "string" }, "timezone": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Company.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } }, { "description": "The provider persona id to query: \n* `1` - Consignee \n* `2` - ISO Tank Depot \n* `3` - Logistics Service Provider \n* `4` - Port \n* `5` - Railhead \n* `6` - Shipper \n* `7` - Shipping Line \n* `8` - Trucking Company \n* `9` - Log Chain \n* `10` - Agent \n* `11` - Bulk Storage Terminal \n", "required": false, "name": "persona", "in": "query", "schema": { "type": "integer", "enum": [ 1, 10, 11, 12, 13, 2, 3, 4, 5, 6, 7, 8 ] } } ], "operationId": "CompanyController.find" }, "delete": { "x-controller-name": "CompanyController", "x-operation-name": "deleteCompany", "tags": [ "Company" ], "responses": { "204": { "description": "Company DELETE success" } }, "operationId": "CompanyController.deleteCompany" } }, "/companies-regulatory": { "put": { "x-controller-name": "CompanyRegulatoryController", "x-operation-name": "upsertRegulatory", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "The ID of the new Regulatory", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } }, "204": { "description": "The Regulatory PUT success" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "uen", "tradeweb_id" ], "properties": { "uen": { "type": "string" }, "tradeweb_id": { "type": "string" } } } } } }, "operationId": "CompanyRegulatoryController.upsertRegulatory" }, "get": { "x-controller-name": "CompanyRegulatoryController", "x-operation-name": "find", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "Array of CompanyRegulatory records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRegulatoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRegulatory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyRegulatoryController.find" } }, "/companies-regulatory-histories": { "get": { "x-controller-name": "CompanyRegulatoryController", "x-operation-name": "findRegulatoryHistories", "tags": [ "Company Regulatory" ], "responses": { "200": { "description": "Array of CompanyRegulatory records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRegulatoryDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyRegulatory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyRegulatoryController.findRegulatoryHistories" } }, "/companies-upload": { "post": { "x-controller-name": "CompanyController", "x-operation-name": "upload", "tags": [ "Company" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CompanyController.upload" } }, "/company/fields/{id}": { "delete": { "x-controller-name": "CompanyFieldController", "x-operation-name": "deleteById", "tags": [ "Company Fields" ], "responses": { "204": { "description": "CompanyField DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyFieldController.deleteById" } }, "/company/fields": { "post": { "x-controller-name": "CompanyFieldController", "x-operation-name": "create", "tags": [ "Company Fields" ], "responses": { "200": { "description": "Create new company field mapping" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "field_name_db": { "type": "string" }, "field_name_xml": { "type": "string" } } } } }, "description": "The request body for creating a new company field mapping." }, "operationId": "CompanyFieldController.create" }, "get": { "x-controller-name": "CompanyFieldController", "x-operation-name": "find", "tags": [ "Company Fields" ], "responses": { "200": { "description": "Array of CompanyField records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFieldDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyField.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyFieldController.find" } }, "/countries": { "get": { "x-controller-name": "CountryController", "x-operation-name": "find", "tags": [ "Country" ], "responses": { "200": { "description": "Array of Country records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Country.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CountryController.find" } }, "/dgds/{id}/override": { "post": { "x-controller-name": "DGDController", "x-operation-name": "override", "tags": [ "DGD" ], "responses": { "200": { "description": "The ID of new DGD", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "form_type": { "type": "number" }, "name_of_company": { "type": "string" }, "name_of_declarant": { "type": "string" }, "place": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "DGDController.override" } }, "/dgds/{id}/validate": { "patch": { "x-controller-name": "DGDController", "x-operation-name": "validate", "tags": [ "DGD" ], "responses": { "200": { "description": "Add more files to DGD" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "DGDController.validate" } }, "/dgds/{id}": { "patch": { "x-controller-name": "DGDController", "x-operation-name": "updateById", "tags": [ "DGD" ], "responses": { "204": { "description": "DGD PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DGDDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-company_id-is_pdf_created-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "DGDController.updateById" }, "get": { "x-controller-name": "DGDController", "x-operation-name": "findById", "tags": [ "DGD" ], "responses": { "200": { "description": "DGD model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "form_type": { "type": "number" }, "name_of_company": { "type": "string" }, "name_of_declarant": { "type": "string" }, "place": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "DGDController.findById" } }, "/dgds": { "get": { "x-controller-name": "DGDController", "x-operation-name": "find", "tags": [ "DGD" ], "responses": { "200": { "description": "Array of DGD records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "form_type": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DGD.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DGDController.find" } }, "/dimension": { "post": { "x-controller-name": "DimensionController", "x-operation-name": "createDimension", "tags": [ "DimensionController" ], "responses": { "200": { "description": "Return value of DimensionController.createDimension" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "DimensionController.createDimension" }, "get": { "x-controller-name": "DimensionController", "x-operation-name": "getAll", "tags": [ "DimensionController" ], "responses": { "200": { "description": "Return value of DimensionController.getAll" } }, "operationId": "DimensionController.getAll" } }, "/documents/verify": { "post": { "x-controller-name": "DocumentController", "x-operation-name": "verify", "tags": [ "Company Documents" ], "responses": { "200": { "description": "Verify a pdf document is valid / invalid" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" } } } } } }, "operationId": "DocumentController.verify" } }, "/documents/verify_and_report": { "post": { "x-controller-name": "DocumentController", "x-operation-name": "verify_and_report", "tags": [ "Company Documents" ], "responses": { "200": { "description": "Verify and report a pdf document is valid / invalid" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "s3_key": { "type": "string" }, "hash": { "type": "string" } } } } } }, "operationId": "DocumentController.verify_and_report" } }, "/documents/{id}/override": { "post": { "x-controller-name": "DocumentController", "x-operation-name": "override", "tags": [ "Company Documents" ], "responses": { "200": { "description": "The ID of new Document", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "flow": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "flow_name": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "status": { "type": "number" }, "status_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "DocumentController.override" } }, "/documents/{id}/validate": { "patch": { "x-controller-name": "DocumentController", "x-operation-name": "validate", "tags": [ "Company Documents" ], "responses": { "200": { "description": "Add more files to document" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "DocumentController.validate" } }, "/documents/{id}": { "patch": { "x-controller-name": "DocumentController", "x-operation-name": "updateById", "tags": [ "Company Documents" ], "responses": { "204": { "description": "Document PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentDtoPartialExcluding_flow_id-company_id-system_actual_date-status_name-is_pdf_created-created_date-created_by-modified_date-modified_by-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "DocumentController.updateById" }, "get": { "x-controller-name": "DocumentController", "x-operation-name": "findById", "tags": [ "Company Documents" ], "responses": { "200": { "description": "Document model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "flow": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "flow_name": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "status": { "type": "number" }, "status_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "DocumentController.findById" } }, "/documents": { "get": { "x-controller-name": "DocumentController", "x-operation-name": "find", "tags": [ "Company Documents" ], "responses": { "200": { "description": "Array of Document records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "flow": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "flow_name": { "type": "string" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_name": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Document.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DocumentController.find" } }, "/eirs/{id}/override": { "post": { "x-controller-name": "EirController", "x-operation-name": "override", "tags": [ "Eir" ], "responses": { "200": { "description": "The ID of new Eir", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "string" }, "receipt_no": { "type": "string" }, "container_no": { "type": "string" }, "delivered_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "delivered_by_name_indirect": { "type": "string" }, "received_by_name_indirect": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "number" }, "field_name": { "type": "string" }, "external_id": { "type": "number" }, "s3_key": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "EirController.override" } }, "/eirs/{id}": { "patch": { "x-controller-name": "EirController", "x-operation-name": "updateById", "tags": [ "Eir" ], "responses": { "204": { "description": "Eir PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EirDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-delivered_company_id-received_company_id-delivered_by-received_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "EirController.updateById" }, "get": { "x-controller-name": "EirController", "x-operation-name": "findById", "tags": [ "Eir" ], "responses": { "200": { "description": "Eir model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "string" }, "receipt_no": { "type": "string" }, "container_no": { "type": "string" }, "delivered_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "delivered_by_name_indirect": { "type": "string" }, "received_by_name_indirect": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "number" }, "field_name": { "type": "string" }, "external_id": { "type": "number" }, "s3_key": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "EirController.findById" } }, "/eirs": { "get": { "x-controller-name": "EirController", "x-operation-name": "find", "tags": [ "Eir" ], "responses": { "200": { "description": "Array of Eir records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "string" }, "receipt_no": { "type": "string" }, "container_no": { "type": "string" }, "delivered_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "received_by": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Eir.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "EirController.find" } }, "/entries/gate/{id}": { "patch": { "x-controller-name": "EntryRecordController", "x-operation-name": "updateById", "tags": [ "Entry" ], "responses": { "204": { "description": "EntryRecord PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryRecordDtoPartialExcluding_type-driven_by-inspected_by-entry_id-entry_record_groups-is_pdf_created-pdf_attempt-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "EntryRecordController.updateById" }, "get": { "x-controller-name": "EntryRecordController", "x-operation-name": "findById", "tags": [ "Entry" ], "responses": { "200": { "description": "EntryRecord model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "gate_in_id": { "type": "number" }, "gate_out_id": { "type": "number" }, "type": { "type": "number" }, "inspection_result": { "type": "number" }, "inspection_result_name": { "type": "string" }, "planed_activity": { "type": "number" }, "planed_activity_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "driven": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "inspected_by": { "type": "number" }, "inspected_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "entry": { "type": "object", "properties": { "id": { "type": "number" }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "number" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } }, "entry_record_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "title": { "type": "string" }, "entry_record_group_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "question": { "type": "string" }, "order": { "type": "number" }, "answer": { "type": "string" }, "remark": { "type": "string" } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "EntryRecordController.findById" } }, "/entries/type/{type}": { "get": { "x-controller-name": "EntryRecordController", "x-operation-name": "findType", "tags": [ "Entry" ], "responses": { "200": { "description": "Array of EntryRecord records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "gate_in_id": { "type": "number" }, "gate_out_id": { "type": "number" }, "type": { "type": "number" }, "inspection_result": { "type": "number" }, "inspection_result_name": { "type": "string" }, "planed_activity": { "type": "number" }, "planed_activity_name": { "type": "string" }, "driven": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "inspected_by": { "type": "number" }, "inspected_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "entry": { "type": "object", "properties": { "id": { "type": "number" }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "number" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" } } } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "EntryRecord.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "type", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "EntryRecordController.findType" } }, "/entries/{id}/entry_records/{er_id}/validate": { "patch": { "x-controller-name": "EntryRecordController", "x-operation-name": "validate", "tags": [ "Entry" ], "responses": { "200": { "description": "Add more files to Entry" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "er_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 2 }, "operationId": "EntryRecordController.validate" } }, "/entries/{id}/gate": { "post": { "x-controller-name": "EntryRecordController", "x-operation-name": "createGate", "tags": [ "Entry" ], "responses": { "200": { "description": "The ID of new EntryRecord", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "method" ], "properties": { "type": { "type": "number", "enum": [ 0, 1 ] }, "remark": { "type": "string" }, "driven_name": { "type": "string" }, "vehicle_no": { "type": "string" }, "inspection_result": { "type": "number", "enum": [ 0, 1 ] }, "planned_activity": { "type": "number" }, "method": { "type": "number", "enum": [ 0, 1 ] }, "entry_record_groups": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "type": "string" }, "entry_record_group_details": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "order": { "type": "number" }, "question": { "type": "string" }, "remark": { "type": "string" } } } } } } }, "driven_by_identifier": { "type": "string", "format": "uuid" }, "checklists": { "type": "array", "minItems": 1, "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } } }, "if": { "properties": { "method": { "const": 1 } } }, "then": { "required": [ "checklists" ] }, "else": { "required": [ "entry_record_groups" ] } } } }, "x-parameter-index": 1 }, "operationId": "EntryRecordController.createGate" } }, "/entries/{id}/override": { "post": { "x-controller-name": "EntryRecordController", "x-operation-name": "override", "tags": [ "Entry" ], "responses": { "200": { "description": "The ID of new EntryRecord", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "method" ], "properties": { "remark": { "type": "string" }, "driven_name": { "type": "string" }, "vehicle_no": { "type": "string" }, "inspection_result": { "type": "number", "enum": [ 0, 1 ] }, "planned_activity": { "type": "number" }, "method": { "type": "number", "enum": [ 0, 1 ] }, "entry_record_groups": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "order": { "type": "number" }, "title": { "type": "string" }, "entry_record_group_details": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "order": { "type": "number" }, "question": { "type": "string" }, "remark": { "type": "string" } } } } } } }, "driven_by_identifier": { "type": "string", "format": "uuid" }, "checklists": { "type": "array", "minItems": 1, "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } } }, "if": { "properties": { "method": { "const": 1 } } }, "then": { "required": [ "checklists" ] }, "else": { "required": [ "entry_record_groups" ] } } } }, "x-parameter-index": 1 }, "operationId": "EntryRecordController.override" } }, "/entries/{id}/references": { "get": { "x-controller-name": "EntryController", "x-operation-name": "getReferenceDocuments", "tags": [ "Entry" ], "responses": { "200": { "description": "Reference documents of entry.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "number" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "gate_in": { "type": "array", "items": { "type": "object", "properties": { "gate_in_id": { "type": "number" }, "inspection_result": { "type": "number" }, "cancelled_action": { "type": "number" } } } }, "gate_out": { "type": "array", "items": { "type": "object", "properties": { "gate_out_id": { "type": "number" }, "inspection_result": { "type": "number" }, "cancelled_action": { "type": "number" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "EntryController.getReferenceDocuments" } }, "/entries": { "get": { "x-controller-name": "EntryController", "x-operation-name": "find", "tags": [ "Entry" ], "responses": { "200": { "description": "Array of Entry records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "number" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "actual_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "gate_in": { "type": "array", "items": { "type": "object", "properties": { "gate_in_id": { "type": "number" }, "inspection_result": { "type": "number" }, "cancelled_action": { "type": "number" } } } }, "gate_out": { "type": "array", "items": { "type": "object", "properties": { "gate_out_id": { "type": "number" }, "inspection_result": { "type": "number" }, "cancelled_action": { "type": "number" } } } } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Entry.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "EntryController.find" } }, "/external/{identifier_token}/action/{id}/type/{type_id}": { "patch": { "x-controller-name": "ExternalController", "x-operation-name": "updateAction", "tags": [ "External" ], "responses": { "200": { "description": "Update success." }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "identifier_token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "type_id", "in": "path", "schema": { "type": "number" }, "description": "\n 2: Lift On \n\n 3: Gate In \n\n 4: Weighbridge Entry \n\n 5: Load Chemical \n\n 6: Weighbridge Exit\n\n 7: Gate Out\n\n 10: Lift Off\n\n 12: Unload Chemical\n\n 14: OnLoading\n\n 15: OffLoading\n\n ", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "actual_weight": { "type": "number", "maximum": 9007199254740991 }, "tare_weight": { "type": "number", "maximum": 9007199254740991 }, "is_weight_safe": { "type": "boolean" }, "is_weight_in_contract": { "type": "boolean" }, "payment_type": { "type": "number", "enum": [ 0, 1 ], "default": 0 }, "amount": { "type": "number", "minimum": 0, "maximum": 9007199254740991 }, "entry_info": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 20 }, "consec_no": { "type": "string", "maxLength": 20 }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0, "maximum": 9007199254740991 } } }, "exit_info": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 20 }, "consec_no": { "type": "string", "maxLength": 20 }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0, "maximum": 9007199254740991 } } }, "planned_activity": { "type": "number", "default": 0 }, "inspection_result": { "type": "number", "enum": [ 0, 1 ], "default": 0 }, "type": { "type": "number", "enum": [ 0, 1 ], "default": 0 }, "remarks": { "type": "string", "maxLength": 10000 }, "cancelled_action": { "type": "integer", "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "maxLength": 10000 }, "attachments": { "type": "string" }, "seals": { "type": "array", "items": { "type": "string" } }, "status": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "default": 1 } } } } }, "required": true, "description": "The request body for create flow from external request.", "x-parameter-index": 4 }, "operationId": "ExternalController.updateAction" } }, "/external/{identifier_token}/flows": { "post": { "x-controller-name": "ExternalController", "x-operation-name": "createExternal", "tags": [ "External" ], "responses": { "200": { "description": "Create the flow from public API" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "identifier_token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "trade_lane_id", "name", "steps" ], "properties": { "trade_lane_id": { "type": "number", "maxLength": 8 }, "name": { "type": "string", "maxLength": 10000 }, "description": { "type": "string", "maxLength": 10000 }, "no_of_container": { "type": "number", "maximum": 30 }, "personas": { "type": "array", "maxItems": 99, "items": { "type": "object", "additionalProperties": false, "properties": { "order": { "type": "number", "maxLength": 8 }, "persona_id": { "type": "number", "maxLength": 8 }, "company_identifier": { "type": "string", "format": "uuid" }, "company_name": { "type": "string", "maxLength": 100 } } } }, "steps": { "type": "array", "maxItems": 99, "items": { "type": "object", "additionalProperties": false, "required": [ "expected_date" ], "properties": { "step_no": { "type": "number", "maxLength": 8 }, "name": { "type": "string", "maxLength": 250 }, "location": { "type": "number", "enum": [ 1, 2, 4, 5, 6, 11 ] }, "actor": { "type": "string", "format": "uuid" }, "container_interval": { "type": "number", "maxLength": 8 }, "expected_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "array", "items": [ { "type": "string", "format": "date-time" } ] } ] }, "access": { "type": "array", "maxItems": 99, "items": { "type": "string", "format": "uuid" } }, "actions": { "type": "array", "maxItems": 99, "items": { "type": "object", "additionalProperties": false, "required": [ "form_id" ], "properties": { "form_actor": { "type": "string", "format": "uuid" }, "form_id": { "type": "number", "enum": [ 0, 2, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ] }, "form_name": { "type": "string", "maxLength": 200 } } } }, "ref_documents": { "type": "array", "maxItems": 99, "items": { "type": "object", "additionalProperties": false, "properties": { "step_name": { "type": "string", "maxLength": 250 }, "form_id": { "type": "number", "enum": [ 0, 2, 3, 4, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ] }, "form_name": { "type": "string", "maxLength": 200 } } } } } } } } } } }, "required": true, "description": "The request body for create flow from external request.", "x-parameter-index": 2 }, "operationId": "ExternalController.createExternal" } }, "/external/{identifier_token}/ftp/actions/generate": { "post": { "x-controller-name": "ExternalController", "x-operation-name": "generateActionsFromFTP_XML", "tags": [ "External" ], "responses": { "200": { "description": "Generate successfully XML to FTP server." }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "identifier_token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ExternalController.generateActionsFromFTP_XML" } }, "/fleets/{id}": { "patch": { "x-controller-name": "FleetController", "x-operation-name": "updateById", "tags": [ "Fleet" ], "responses": { "204": { "description": "Updates the Trucking information globally. \n" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "vehicle_no": { "type": "string" }, "delivered_by": { "type": "string" }, "delivery_note": { "type": "string" }, "reason_for_change": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "FleetController.updateById" }, "get": { "x-controller-name": "FleetController", "x-operation-name": "findById", "tags": [ "Fleet" ], "responses": { "200": { "description": "FleetView model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetViewDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FleetController.findById" } }, "/fleets": { "get": { "x-controller-name": "FleetController", "x-operation-name": "find", "tags": [ "Fleet" ], "responses": { "200": { "description": "Array of FleetView records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FleetViewDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FleetView.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FleetController.find" } }, "/flows/{id}/groups": { "put": { "x-controller-name": "FlowController", "x-operation-name": "upsertGroup", "tags": [ "Flow" ], "responses": { "200": { "description": "The ID of groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Group PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "groups" ], "properties": { "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true, "minItems": 1 }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the group.", "x-parameter-index": 1 }, "operationId": "FlowController.upsertGroup" } }, "/flows/{id}/notification/toggle": { "patch": { "x-controller-name": "FlowController", "x-operation-name": "toggleFlowNotification", "tags": [ "Flow" ], "responses": { "200": { "description": "Toggle flow notification" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowController.toggleFlowNotification" } }, "/flows/{id}/personas": { "put": { "x-controller-name": "FlowController", "x-operation-name": "upsertPersona", "tags": [ "Flow" ], "responses": { "200": { "description": "The ID of reference personas", "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_personas": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Reference personas PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ref_personas" ], "properties": { "ref_personas": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "persona_id", "company_identifier" ], "properties": { "company_name": { "type": "string" }, "company_identifier": { "type": "string", "format": "uuid" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "company_name": { "type": "string" }, "company_identifier": { "type": "string", "format": "uuid" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 1 }, "operationId": "FlowController.upsertPersona" }, "get": { "x-controller-name": "FlowPersonaController", "x-operation-name": "find", "tags": [ "Flow" ], "responses": { "200": { "description": "Array of FlowPersona records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowPersonaDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FlowPersona.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowPersonaController.find" } }, "/flows/{id}/steps/{step_id}": { "put": { "x-controller-name": "FlowController", "x-operation-name": "upsertStepDetails", "tags": [ "Flow" ], "responses": { "200": { "description": "The ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 2 }, "operationId": "FlowController.upsertStepDetails" } }, "/flows/{id}/steps": { "put": { "x-controller-name": "FlowController", "x-operation-name": "upsertStep", "tags": [ "Flow" ], "responses": { "200": { "description": "The array ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "name", "persona_id", "order", "flow_persona_id" ], "properties": { "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the step", "x-parameter-index": 1 }, "operationId": "FlowController.upsertStep" } }, "/flows/{id}": { "get": { "x-controller-name": "FlowController", "x-operation-name": "findById", "tags": [ "Flow" ], "responses": { "200": { "description": "Flow model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "step_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "group_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "r_journey", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FlowController.findById" }, "delete": { "x-controller-name": "FlowController", "x-operation-name": "deleteById", "tags": [ "Flow" ], "responses": { "204": { "description": "Default flow DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowController.deleteById" } }, "/flows": { "put": { "x-controller-name": "FlowController", "x-operation-name": "upsertFlow", "tags": [ "Flow" ], "responses": { "200": { "description": "The ID of new flows", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } }, "204": { "description": "The flow PUT success" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFlow1" } } } }, "operationId": "FlowController.upsertFlow" }, "get": { "x-controller-name": "FlowController", "x-operation-name": "find", "tags": [ "Flow" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowController.find" } }, "/flows-alerts/{id}": { "patch": { "x-controller-name": "FlowAlertController", "x-operation-name": "updateById", "tags": [ "Flow Alerts" ], "responses": { "204": { "description": "VerificationView PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationViewPartialExcluding_flow_id-flow_journey_point_id-flow_action_id-form_id-verification_id-is_actor-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "FlowAlertController.updateById" }, "get": { "x-controller-name": "FlowAlertController", "x-operation-name": "findById", "tags": [ "Flow Alerts" ], "responses": { "200": { "description": "VerificationView model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationView" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowAlertController.findById" } }, "/flows-alerts": { "get": { "x-controller-name": "FlowAlertController", "x-operation-name": "find", "tags": [ "Flow Alerts" ], "responses": { "200": { "description": "Array of VerificationView records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/VerificationView" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "VerificationView.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowAlertController.find" } }, "/flows-default/{id}": { "get": { "x-controller-name": "FlowDefaultController", "x-operation-name": "findById", "tags": [ "Flow Default" ], "responses": { "200": { "description": "FlowDefault model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" } } }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "identifier": { "type": "string" } } }, "description": { "type": "string" }, "name": { "type": "string" }, "reference_1": { "type": "string" }, "reference_2": { "type": "string" }, "reference_3": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "journey_points": { "type": "array", "items": { "type": "string" } }, "group_personas": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" } } } } } } }, "journey_points": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "persona_id": { "type": "number" } } } }, "journey_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_default_form": { "type": "object", "properties": { "name": { "type": "string" }, "from_id": { "type": "string" } } }, "flow_default_personas": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "journey_consensus": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_default_personas": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "step_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "group_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "r_journey", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FlowDefaultController.findById" } }, "/flows-default": { "get": { "x-controller-name": "FlowDefaultController", "x-operation-name": "find", "tags": [ "Flow Default" ], "responses": { "200": { "description": "Array of FlowDefault records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" } } }, "name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FlowDefault.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowDefaultController.find" } }, "/flows-journeys/report/pdf": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "reportPDF", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Return value of FlowJourneyController.reportPDF" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.reportPDF" } }, "/flows-journeys/report": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "report", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.report" } }, "/flows-journeys/report-master/precompute": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "precomputeReportMaster", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.precomputeReportMaster" } }, "/flows-journeys/report-master/xls": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "reportMasterXLS", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.reportMasterXLS" } }, "/flows-journeys/report-master": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "reportMaster", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.reportMaster" } }, "/flows-journeys/search": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "search", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.search" } }, "/flows-journeys/{id}/categories": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "updateCategories", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Update categories of flow." } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "category_ids": { "type": "array", "items": { "type": "number" } } } } } }, "x-parameter-index": 1 }, "operationId": "FlowJourneyController.updateCategories" } }, "/flows-journeys/{id}/container_no/cancel": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "cancelContainerNo", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Cancel container_no of action's data of flow." } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "containers": { "type": "array", "items": { "type": "string", "maxLength": 100 } }, "uri": { "type": "string" }, "reason": { "type": "string", "maxLength": 5000 } } } } }, "x-parameter-index": 1 }, "operationId": "FlowJourneyController.cancelContainerNo" } }, "/flows-journeys/{id}/container_no": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "updateContainerNo", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Update container_no of action's data of flow." } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "containers": { "type": "array", "items": { "type": "string", "maxLength": 100, "nullable": true } }, "uri": { "type": "string" }, "reason": { "type": "string", "maxLength": 5000 } } } } }, "x-parameter-index": 1 }, "operationId": "FlowJourneyController.updateContainerNo" } }, "/flows-journeys/{id}/expected_dates": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "updateExpectedDates", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Update expected dates of action's data of flow." } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number", "maximum": 9007199254740991 }, "expected_date": { "type": "string", "format": "date-time" } } } }, "uri": { "type": "string" }, "reason": { "type": "string", "maxLength": 5000 } } } } }, "x-parameter-index": 1 }, "operationId": "FlowJourneyController.updateExpectedDates" } }, "/flows-journeys/{id}/flow_action_notification/toggle": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "toggleFlowNotification", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Toggle flow action notification" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "FlowJourneyController.toggleFlowNotification" } }, "/flows-journeys/{id}": { "patch": { "x-controller-name": "FlowJourneyController", "x-operation-name": "cancelFlowById", "tags": [ "Flow Journeys" ], "responses": { "204": { "description": "Updates the flow information globally. Updates possible are: \n* Cancel or Reject a flow \n* Give reason to cancel a flow" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelled_reason": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "FlowJourneyController.cancelFlowById" }, "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "findByFlowId", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Flow Journeys Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step_id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "operationId": "FlowJourneyController.findByFlowId" } }, "/flows-journeys": { "get": { "x-controller-name": "FlowJourneyController", "x-operation-name": "find", "tags": [ "Flow Journeys" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowJourneyController.find" } }, "/flows-validate/{id}/exists/{container_no}": { "get": { "x-controller-name": "FlowValidationController", "x-operation-name": "validateContainerNoExistOnOtherFlows", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "Check container existing on other flows", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "container_no", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "FlowValidationController.validateContainerNoExistOnOtherFlows" } }, "/flows-validate/{id}/groups": { "put": { "x-controller-name": "FlowValidationController", "x-operation-name": "upsertGroup", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "The ID of groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Group PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "groups" ], "properties": { "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true, "minItems": 1 }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the group.", "x-parameter-index": 1 }, "operationId": "FlowValidationController.upsertGroup" } }, "/flows-validate/{id}/personas": { "put": { "x-controller-name": "FlowValidationController", "x-operation-name": "upsertPersona", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "The ID of reference personas", "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_personas": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Reference personas PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ref_personas" ], "properties": { "ref_personas": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "persona_id", "name" ], "properties": { "name": { "type": "string" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 1 }, "operationId": "FlowValidationController.upsertPersona" } }, "/flows-validate/{id}/steps/{step_id}": { "put": { "x-controller-name": "FlowValidationController", "x-operation-name": "upsertStepDetails", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "The ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" } } } } }, "description": "The request body for create or update the persona.", "x-parameter-index": 2 }, "operationId": "FlowValidationController.upsertStepDetails" }, "patch": { "x-controller-name": "FlowValidationController", "x-operation-name": "updateStepDetails", "tags": [ "Flow Validation" ], "responses": { "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "location_id": { "type": "number" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "actor": { "type": "string" }, "company_other": { "type": "string" }, "company_other_type": { "type": "number", "nullable": true }, "delivered_company": { "type": "string" }, "trucking_company": { "type": "string" }, "customer": { "type": "string" }, "received_company": { "type": "string" }, "job_no": { "type": "number", "nullable": true }, "order_no": { "type": "string", "nullable": true } } } } } } } }, "x-parameter-index": 2 }, "operationId": "FlowValidationController.updateStepDetails" } }, "/flows-validate/{id}/steps": { "put": { "x-controller-name": "FlowValidationController", "x-operation-name": "upsertStep", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "The array ID of journey point", "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "oneOf": [ { "type": "number" }, { "type": "boolean" } ] } } } } } } }, "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "name", "persona_id", "order", "flow_persona_id" ], "properties": { "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "form_data": { "type": "object" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "persona_id": { "type": "number" }, "flow_persona_id": { "type": "number" }, "order": { "type": "number" }, "actions": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "flow_persona_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "form_id": { "type": "number" }, "flow_persona_id": { "type": "number" } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } }, "ref_documents": { "type": "array", "uniqueItems": true, "items": { "type": "number" } }, "expected_date": { "type": "string", "format": "date-time" }, "groups": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "required": [ "name", "order", "flow_personas" ], "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "uniqueItems": true } } }, { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "flow_personas": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true }, "journey_points": { "type": "array", "items": { "type": "number" }, "minItems": 1, "uniqueItems": true } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } }, { "type": "object", "required": [ "id", "delete" ], "properties": { "id": { "type": "number" }, "delete": { "type": "boolean" } } } ] } } } } } }, "description": "The request body for create or update the step", "x-parameter-index": 1 }, "operationId": "FlowValidationController.upsertStep" }, "patch": { "x-controller-name": "FlowValidationController", "x-operation-name": "updateSteps", "tags": [ "Flow Validation" ], "responses": { "204": { "description": "Journey points PUT success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "step_id": { "type": "number" }, "location_id": { "type": "number" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "actor": { "type": "string" }, "company_other": { "type": "string" }, "company_other_type": { "type": "number", "nullable": true }, "delivered_company": { "type": "string" }, "trucking_company": { "type": "string" }, "customer": { "type": "string" }, "received_company": { "type": "string" }, "job_no": { "type": "number", "nullable": true }, "order_no": { "type": "string", "nullable": true } } } } } } } } }, "x-parameter-index": 1 }, "operationId": "FlowValidationController.updateSteps" } }, "/flows-validate/{id}/validation/{flow_persona_id}": { "patch": { "x-controller-name": "FlowValidationController", "x-operation-name": "validateFlowAsOther", "tags": [ "Flow Validation" ], "responses": { "204": { "description": "Updates the flow information globally. Updates possible are: \n* Validate or Reject a flow \n* Give remarks to a flow" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "flow_persona_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "enum": [ 4, 5 ] }, "remarks": { "type": "string" } } } } }, "x-parameter-index": 2 }, "operationId": "FlowValidationController.validateFlowAsOther" } }, "/flows-validate/{id}": { "patch": { "x-controller-name": "FlowValidationController", "x-operation-name": "updateById", "tags": [ "Flow Validation" ], "responses": { "204": { "description": "Updates the flow information globally. Updates possible are: \n* Validate or Reject a flow \n* Give remarks to a flow" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "enum": [ 4, 5 ] }, "remarks": { "type": "string" }, "category_ids": { "type": "array", "maxItems": 100, "items": { "type": "number" }, "nullable": true }, "needed_info": { "type": "object", "properties": { "container_no": { "type": "array", "maxItems": 30, "items": { "type": "string" }, "nullable": true }, "product_no": { "type": "string", "nullable": true }, "desired_temp": { "type": "number", "nullable": true } } } } } } }, "x-parameter-index": 1 }, "operationId": "FlowValidationController.updateById" }, "get": { "x-controller-name": "FlowValidationController", "x-operation-name": "findById", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "Flow model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "step", "in": "query", "schema": { "enum": [ 1, 2, 3 ], "type": "number" } }, { "name": "step_id", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "flow_persona_id", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "operationId": "FlowValidationController.findById" } }, "/flows-validate": { "put": { "x-controller-name": "FlowValidationController", "x-operation-name": "upsertFlow", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "The ID of new flows", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } }, "204": { "description": "The flow PUT success" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowDto" } } } }, "operationId": "FlowValidationController.upsertFlow" }, "get": { "x-controller-name": "FlowValidationController", "x-operation-name": "find", "tags": [ "Flow Validation" ], "responses": { "200": { "description": "Array of Flow records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FlowValidationController.find" } }, "/grafana/token": { "get": { "x-controller-name": "GrafanaTokenController", "x-operation-name": "getGrafanaToken", "tags": [ "GrafanaTokenController" ], "responses": { "200": { "description": "Returns a short-lived Grafana JWT", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "expires_in": { "type": "number" } } } } } } }, "operationId": "GrafanaTokenController.getGrafanaToken" } }, "/holiday-calendar/bulk-import": { "post": { "x-controller-name": "SlaConfigController", "x-operation-name": "bulkImportHolidays", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.bulkImportHolidays" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "holidays" ], "properties": { "holidays": { "type": "array", "items": { "type": "object", "required": [ "holiday_date", "holiday_name" ], "properties": { "holiday_date": { "type": "string", "format": "date" }, "holiday_name": { "type": "string" }, "country_code": { "type": "string" } } } } } } } } }, "operationId": "SlaConfigController.bulkImportHolidays" } }, "/holiday-calendar/{id}": { "put": { "x-controller-name": "SlaConfigController", "x-operation-name": "updateHoliday", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.updateHoliday" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "SlaConfigController.updateHoliday" }, "delete": { "x-controller-name": "SlaConfigController", "x-operation-name": "deleteHoliday", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.deleteHoliday" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SlaConfigController.deleteHoliday" } }, "/holiday-calendar": { "post": { "x-controller-name": "SlaConfigController", "x-operation-name": "addHoliday", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.addHoliday" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "holiday_date", "holiday_name" ], "properties": { "holiday_date": { "type": "string", "format": "date" }, "holiday_name": { "type": "string" }, "country_code": { "type": "string" } } } } } }, "operationId": "SlaConfigController.addHoliday" }, "get": { "x-controller-name": "SlaConfigController", "x-operation-name": "listHolidays", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.listHolidays" } }, "parameters": [ { "name": "countryCode", "in": "query", "schema": { "type": "string" } }, { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "SlaConfigController.listHolidays" } }, "/licences/{id}": { "patch": { "x-controller-name": "LicenceController", "x-operation-name": "updateById", "tags": [ "Licence" ], "responses": { "204": { "description": "Licence PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenceDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "LicenceController.updateById" }, "get": { "x-controller-name": "LicenceController", "x-operation-name": "findById", "tags": [ "Licence" ], "responses": { "200": { "description": "Licence model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenceDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "LicenceController.findById" }, "delete": { "x-controller-name": "LicenceController", "x-operation-name": "deleteById", "tags": [ "Licence" ], "responses": { "204": { "description": "Licence DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "LicenceController.deleteById" } }, "/licences": { "post": { "x-controller-name": "LicenceController", "x-operation-name": "create", "tags": [ "Licence" ], "responses": { "200": { "description": "Create new Licence" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100, "minLength": 1, "default": "", "description": "Licence name", "example": "licence_name" }, "description": { "type": "string", "default": "" }, "type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 0 }, "is_monthly": { "type": "boolean", "default": false }, "monthly_rate": { "type": "number", "default": 0 }, "is_yearly": { "type": "boolean", "default": false }, "yearly_rate": { "type": "number", "default": 0 }, "company_referred": { "type": "number", "default": 0 }, "white_collar_users": { "type": "number", "default": 0 }, "blue_collar_users": { "type": "number", "default": 0 }, "company_referred_white_collar_users": { "type": "number", "default": 0 }, "company_referred_blue_collar_users": { "type": "number", "default": 0 }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1 } } } } }, "description": "The request body for creating licence." }, "operationId": "LicenceController.create" }, "get": { "x-controller-name": "LicenceController", "x-operation-name": "find", "tags": [ "Licence" ], "responses": { "200": { "description": "Array of Licence records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LicenceDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Licence.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LicenceController.find" } }, "/lifts/{id}/override": { "post": { "x-controller-name": "LiftController", "x-operation-name": "override", "tags": [ "Lift" ], "responses": { "200": { "description": "The ID of new Lift", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "tare_weight": { "type": "number" }, "planned_activity": { "type": "number" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "LiftController.override" } }, "/lifts/{id}/validate": { "patch": { "x-controller-name": "LiftController", "x-operation-name": "validate", "tags": [ "Lift" ], "responses": { "200": { "description": "Add more files to Lift" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "LiftController.validate" } }, "/lifts/{id}": { "patch": { "x-controller-name": "LiftController", "x-operation-name": "updateById", "tags": [ "Lift" ], "responses": { "204": { "description": "Lift PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiftDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "LiftController.updateById" }, "get": { "x-controller-name": "LiftController", "x-operation-name": "findById", "tags": [ "Lift" ], "responses": { "200": { "description": "Lift model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "tare_weight": { "type": "number" }, "planned_activity": { "type": "number" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "LiftController.findById" } }, "/lifts": { "get": { "x-controller-name": "LiftController", "x-operation-name": "find", "tags": [ "Lift" ], "responses": { "200": { "description": "Array of Lift records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "tare_weight": { "type": "number" }, "planned_activity": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Lift.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LiftController.find" } }, "/loadings/{id}/override": { "post": { "x-controller-name": "LoadingController", "x-operation-name": "override", "tags": [ "Loading" ], "responses": { "200": { "description": "The ID of new Loading", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "is_weight_safe": { "type": "boolean" }, "is_weight_in_contract": { "type": "boolean" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "LoadingController.override" } }, "/loadings/{id}/validate": { "patch": { "x-controller-name": "LoadingController", "x-operation-name": "validate", "tags": [ "Loading" ], "responses": { "200": { "description": "Add more files to Loading" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "LoadingController.validate" } }, "/loadings/{id}": { "patch": { "x-controller-name": "LoadingController", "x-operation-name": "updateById", "tags": [ "Loading" ], "responses": { "204": { "description": "Loading PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "LoadingController.updateById" }, "get": { "x-controller-name": "LoadingController", "x-operation-name": "findById", "tags": [ "Loading" ], "responses": { "200": { "description": "Loading model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "is_weight_safe": { "type": "boolean" }, "is_weight_in_contract": { "type": "boolean" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "LoadingController.findById" } }, "/loadings": { "get": { "x-controller-name": "LoadingController", "x-operation-name": "find", "tags": [ "Loading" ], "responses": { "200": { "description": "Array of Loading records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loading.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadingController.find" } }, "/locodes": { "get": { "x-controller-name": "LocodeController", "x-operation-name": "find", "tags": [ "Locode" ], "responses": { "200": { "description": "Array of Locode records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "country": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "name": { "type": "string" }, "code": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Locode.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } } ], "operationId": "LocodeController.find" } }, "/locodes-upload": { "post": { "x-controller-name": "LocodeController", "x-operation-name": "upload", "tags": [ "Locode" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "LocodeController.upload" } }, "/logchain-regulatory/companies/{uen}/transactions/{id}": { "patch": { "x-controller-name": "CalistaController", "x-operation-name": "updateTransaction", "tags": [ "Calista" ], "responses": { "200": { "description": "Submit the regulatory declaration" } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } }, { "name": "uen", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } }, "required": true, "x-parameter-index": 3 }, "operationId": "CalistaController.updateTransaction" } }, "/notifications/{id}/read": { "patch": { "x-controller-name": "NotificationController", "x-operation-name": "markAsRead", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Return value of NotificationController.markAsRead" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotificationController.markAsRead" } }, "/onloadings/{id}/override": { "post": { "x-controller-name": "OnLoadingController", "x-operation-name": "override", "tags": [ "OnLoading" ], "responses": { "200": { "description": "The ID of new OnLoading", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "is_weight_safe": { "type": "boolean" }, "is_weight_in_contract": { "type": "boolean" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "OnLoadingController.override" } }, "/onloadings/{id}/validate": { "patch": { "x-controller-name": "OnLoadingController", "x-operation-name": "validate", "tags": [ "OnLoading" ], "responses": { "200": { "description": "Add more files to OnLoading" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "OnLoadingController.validate" } }, "/onloadings/{id}": { "patch": { "x-controller-name": "OnLoadingController", "x-operation-name": "updateById", "tags": [ "OnLoading" ], "responses": { "204": { "description": "OnLoading PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnLoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "OnLoadingController.updateById" }, "get": { "x-controller-name": "OnLoadingController", "x-operation-name": "findById", "tags": [ "OnLoading" ], "responses": { "200": { "description": "OnLoading model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "is_weight_safe": { "type": "boolean" }, "is_weight_in_contract": { "type": "boolean" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "OnLoadingController.findById" } }, "/onloadings": { "get": { "x-controller-name": "OnLoadingController", "x-operation-name": "find", "tags": [ "OnLoading" ], "responses": { "200": { "description": "Array of OnLoading records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "delivered": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "supervise": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "type": { "type": "number" }, "vehicle_no": { "type": "string" }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number" }, "actual_weight": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "OnLoading.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "OnLoadingController.find" } }, "/parties/{id}": { "delete": { "x-controller-name": "CompanyPartyController", "x-operation-name": "deleteById", "tags": [ "Party" ], "responses": { "204": { "description": "CompanyParty DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyPartyController.deleteById" } }, "/parties": { "post": { "x-controller-name": "CompanyPartyController", "x-operation-name": "create", "tags": [ "Party" ], "responses": { "200": { "description": "Create new company party" }, "400": { "description": "Validation Errors (Bad Request)" }, "401": { "description": "Unauthorized Error" }, "500": { "description": "Internal Server Error (System Error)" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "party_persona_id": { "type": "number" }, "party_company_id": { "type": "number" } } } } }, "description": "The request body for creating company party." }, "operationId": "CompanyPartyController.create" }, "get": { "x-controller-name": "CompanyPartyController", "x-operation-name": "find", "tags": [ "Party" ], "responses": { "200": { "description": "Array of CompanyParty records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyPartyDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyParty.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyPartyController.find" } }, "/pdf/parse": { "post": { "x-controller-name": "AWSController", "x-operation-name": "parsePDF", "tags": [ "Aws" ], "responses": { "200": { "description": "Read the pdf file and extract text from it." } }, "parameters": [ { "name": "x-api-key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pdf_id": { "type": "number" }, "s3_key": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "AWSController.parsePDF" } }, "/personas/actions/{cargo_type}": { "get": { "x-controller-name": "PersonaController", "x-operation-name": "getActionsByPersonaAndCargo", "tags": [ "Persona" ], "responses": { "200": { "description": "The request body for get actions by persona and cargo.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "persona_id": { "type": "number" }, "title": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "action_id": { "type": "number" }, "color": { "type": "string" }, "form_id": { "type": "number" }, "form_name": { "type": "string" }, "form_type": { "type": "string" }, "icon": { "type": "string" } } } } } } } } } } }, "parameters": [ { "name": "cargo_type", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "PersonaController.getActionsByPersonaAndCargo" } }, "/personas/actions": { "get": { "x-controller-name": "PersonaController", "x-operation-name": "getActionsByPersona", "tags": [ "Persona" ], "responses": { "200": { "description": "The request body for get actions by personas.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "persona_id": { "type": "number" }, "title": { "type": "string" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "order": { "type": "number" }, "action_id": { "type": "number" }, "color": { "type": "string" }, "form_id": { "type": "number" }, "form_name": { "type": "string" }, "form_type": { "type": "string" }, "icon": { "type": "string" } } } } } } } } } } }, "operationId": "PersonaController.getActionsByPersona" } }, "/personas": { "get": { "x-controller-name": "PersonaController", "x-operation-name": "find", "tags": [ "Persona" ], "responses": { "200": { "description": "Array of Persona records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Persona.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PersonaController.find" } }, "/pmo/by-ids": { "get": { "x-controller-name": "PmoController", "x-operation-name": "getByIds", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.getByIds" } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "string" } } ], "operationId": "PmoController.getByIds" } }, "/pmo/manual-update": { "post": { "x-controller-name": "PmoController", "x-operation-name": "manualUpdate", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.manualUpdate" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "data" ], "properties": { "id": { "type": "number" }, "data": { "type": "object" } } } } } }, "operationId": "PmoController.manualUpdate" } }, "/pmo/manual-update-batch": { "post": { "x-controller-name": "PmoController", "x-operation-name": "manualUpdateBatch", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.manualUpdateBatch" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PmoController.manualUpdateBatch" } }, "/pmo/reject": { "post": { "x-controller-name": "PmoController", "x-operation-name": "reject", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.reject" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PmoController.reject" } }, "/pmo/run-import-cronjob": { "post": { "x-controller-name": "PmoController", "x-operation-name": "runImportCronJob", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.runImportCronJob" } }, "operationId": "PmoController.runImportCronJob" } }, "/pmo/unlink": { "post": { "x-controller-name": "PmoController", "x-operation-name": "unlinkPmo", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.unlinkPmo" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "temporaryNo": { "type": "string" } } } } } }, "operationId": "PmoController.unlinkPmo" } }, "/pmo/update-status": { "post": { "x-controller-name": "PmoController", "x-operation-name": "updateStatus", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.updateStatus" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "nextStatus" ], "properties": { "pmos": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "currentStatus": { "type": "number" } }, "required": [ "id", "currentStatus" ] } }, "additonal_information": { "type": "string" }, "nextStatus": { "type": "number" }, "temporaryNo": { "type": "string" }, "pmoTemporaryNos": { "type": "array", "items": { "type": "object", "properties": { "pmoId": { "type": "number" }, "temporaryNo": { "type": "string" } } } } } } } } }, "operationId": "PmoController.updateStatus" } }, "/pmo": { "get": { "x-controller-name": "PmoController", "x-operation-name": "getAllPmo", "tags": [ "PmoController" ], "responses": { "200": { "description": "Return value of PmoController.getAllPmo" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "number" } }, { "name": "showDrop", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortOrder", "in": "query", "schema": { "type": "string" } } ], "operationId": "PmoController.getAllPmo" } }, "/product-hazards": { "get": { "x-controller-name": "ProductHazardController", "x-operation-name": "find", "tags": [ "ProductHazard" ], "responses": { "200": { "description": "Array of ProductHazard records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProductHazard.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProductHazardController.find" } }, "/product-hazards-upload": { "post": { "x-controller-name": "ProductHazardController", "x-operation-name": "upload", "tags": [ "ProductHazard" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "ProductHazardController.upload" } }, "/profiles/activities": { "get": { "x-controller-name": "ProfileController", "x-operation-name": "find", "tags": [ "Profile" ], "responses": { "200": { "description": "Array of UserActivity records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "activity": { "type": "string" }, "description": { "type": "string" }, "activity_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "UserActivity.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProfileController.find" } }, "/profiles/settings": { "patch": { "x-controller-name": "ProfileController", "x-operation-name": "updateSettings", "tags": [ "Profile" ], "responses": { "204": { "description": "Settings PATCH success" } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingPartialExcluding_main_contact_id-status-sub-company_id-password-role_id-is_admin-change_password-blockchain_status-blockchain_certificate-name-avatar-contact_number-contact_email-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } } }, "operationId": "ProfileController.updateSettings" } }, "/profiles": { "patch": { "x-controller-name": "ProfileController", "x-operation-name": "updateInfoByIdentifier", "tags": [ "Profile" ], "responses": { "204": { "description": "Profile PATCH success" } }, "requestBody": { "content": { "application/json": {} } }, "operationId": "ProfileController.updateInfoByIdentifier" }, "get": { "x-controller-name": "ProfileController", "x-operation-name": "findByIdentifier", "tags": [ "Profile" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" }, "identifier": { "type": "string" } } }, "password": { "type": "string" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "avatar": { "type": "string" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_admin_name": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "login_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "blockchain_identity": { "type": "object", "properties": { "valid_from": { "type": "string", "format": "date-time" }, "valid_to": { "type": "string", "format": "date-time" }, "issuer_cn": { "type": "string" }, "subject_cn": { "type": "string" } } } } } } } } }, "operationId": "ProfileController.findByIdentifier" }, "delete": { "x-controller-name": "ProfileController", "x-operation-name": "deleteMyAccount", "tags": [ "Profile" ], "responses": { "204": { "description": "User DELETE success" } }, "operationId": "ProfileController.deleteMyAccount" } }, "/reason-config": { "get": { "x-controller-name": "ReasonConfigController", "x-operation-name": "getByAction", "tags": [ "ReasonConfigController" ], "responses": { "200": { "description": "Return value of ReasonConfigController.getByAction" } }, "parameters": [ { "name": "action", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReasonConfigController.getByAction" } }, "/regulatory-dashboards/{id}": { "patch": { "x-controller-name": "RegulatoryDashboardsController", "x-operation-name": "updateById", "tags": [ "Regulatory Dashboards" ], "responses": { "204": { "description": "RegulatoryDashboards PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string" }, "value": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "maxLength": 50 }, "rule": { "type": "string", "maxLength": 50 }, "value": { "type": "string", "maxLength": 50 } } } } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDashboardsController.updateById" }, "get": { "x-controller-name": "RegulatoryDashboardsController", "x-operation-name": "findById", "tags": [ "Regulatory Dashboards" ], "responses": { "200": { "description": "RegulatoryDashboards model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryDashboardsDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDashboardsController.findById" }, "delete": { "x-controller-name": "RegulatoryDashboardsController", "x-operation-name": "deleteById", "tags": [ "Regulatory Dashboards" ], "responses": { "204": { "description": "RegulatoryDashboards DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDashboardsController.deleteById" } }, "/regulatory-dashboards": { "post": { "x-controller-name": "RegulatoryDashboardsController", "x-operation-name": "create", "tags": [ "Regulatory Dashboards" ], "responses": { "200": { "description": "The ID of new RegulatoryDashboards", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "value", "filters" ], "additionalProperties": false, "properties": { "title": { "type": "string" }, "value": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "maxLength": 50 }, "rule": { "type": "string", "maxLength": 50 }, "value": { "type": "string", "maxLength": 50 } } } } } } } } }, "operationId": "RegulatoryDashboardsController.create" }, "get": { "x-controller-name": "RegulatoryDashboardsController", "x-operation-name": "find", "tags": [ "Regulatory Dashboards" ], "responses": { "200": { "description": "Array of RegulatoryDashboards records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryDashboardsDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryDashboards.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RegulatoryDashboardsController.find" } }, "/regulatory-declarations/dashboard": { "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "calcStatisticDeclaration", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Statistic of regulatory declaration" } }, "operationId": "RegulatoryDeclarationsController.calcStatisticDeclaration" } }, "/regulatory-declarations/filters/flows": { "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findFiltersFlows", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Array of FlowFilter records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FlowFilterDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Flow.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RegulatoryDeclarationsController.findFiltersFlows" } }, "/regulatory-declarations/parties": { "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findParties", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The list of parties" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryParties.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RegulatoryDeclarationsController.findParties" } }, "/regulatory-declarations/{id}/cargos": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertCargo", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Create a cargos successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "release_loc": { "type": "object", "required": [ "loc_code", "loc_name" ], "locodeMustExists": true, "properties": { "loc_code": { "type": "string", "maxLength": 7 }, "loc_name": { "type": "string", "maxLength": 256 } } }, "receipt_loc": { "type": "object", "required": [ "loc_code", "loc_name" ], "locodeMustExists": true, "properties": { "loc_code": { "type": "string", "maxLength": 7 }, "loc_name": { "type": "string", "maxLength": 256 } } }, "storage_loc": { "type": "object", "locodeMustExists": true, "required": [ "loc_code" ], "properties": { "loc_code": { "type": "string", "maxLength": 7 } } }, "blanket_start_date": { "type": "string", "format": "date-time" }, "containers": { "type": "array", "items": { "type": "object", "required": [ "ctn_no", "ctn_type_size", "ctn_wt_value", "ctn_seal_no" ], "locodeMustExists": true, "properties": { "id": { "type": "number" }, "ctn_no": { "type": "string", "maxLength": 13, "isContainer": true, "transform": [ "toUpperCase" ] }, "ctn_type_size": { "codeMustExists": true, "type": "string", "maxLength": 5 }, "ctn_wt_value": { "type": "number", "applyPattern": { "pattern": {} } }, "ctn_seal_no": { "type": "string", "maxLength": 35 } } } } }, "required": [ "release_loc", "receipt_loc" ] } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertCargo" } }, "/regulatory-declarations/{id}/clones": { "post": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "clone", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Copy a declaration successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "additionalProperties": false, "properties": { "all": { "type": "boolean" }, "header": { "type": "object", "required": [], "additionalProperties": false, "properties": { "add_recipients": { "type": "boolean" }, "amendment": { "type": "boolean" }, "bg_ind": { "type": "boolean" }, "calista_job_no": { "type": "boolean" }, "calista_status": { "type": "boolean" }, "car_type": { "type": "boolean" }, "company_id": { "type": "boolean" }, "company_regulatory_id": { "type": "boolean" }, "dec_stmt_ind": { "type": "boolean" }, "dec_type": { "type": "boolean" }, "declaration_file": { "type": "boolean" }, "flow_id": { "type": "boolean" }, "has_ref_docs": { "type": "boolean" }, "hash": { "type": "boolean" }, "in_tpt_mode": { "type": "boolean" }, "licences": { "type": "boolean" }, "message": { "type": "boolean" }, "message_version": { "type": "boolean" }, "out_tpt_mode": { "type": "boolean" }, "pack_type": { "type": "boolean" }, "remarks": { "type": "boolean" }, "seq_no": { "type": "boolean" }, "status": { "type": "boolean" }, "supply_ind": { "type": "boolean" }, "tot_cif_fob_amt": { "type": "boolean" }, "tot_duty_tax": { "type": "boolean" }, "tot_gross_wt": { "type": "boolean" }, "tot_item": { "type": "boolean" }, "tot_out_pack": { "type": "boolean" }, "update_pmt_no": { "type": "boolean" }, "version": { "type": "boolean" } } }, "party": { "type": "object", "required": [], "additionalProperties": false, "properties": { "declaring_agent": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "freight_forwarder": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "in_carrier_agent": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "importer": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "out_carrier_agent": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "exporter": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" }, "city": { "type": "boolean" }, "sbt_code": { "type": "boolean" }, "sbt_name": { "type": "boolean" }, "pst_code": { "type": "boolean" }, "cty_code": { "type": "boolean" } } }, "consignee": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" }, "city": { "type": "boolean" }, "sbt_code": { "type": "boolean" }, "sbt_name": { "type": "boolean" }, "pst_code": { "type": "boolean" }, "cty_code": { "type": "boolean" } } }, "claimant": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" } } }, "end_user": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" }, "city": { "type": "boolean" }, "sbt_code": { "type": "boolean" }, "sbt_name": { "type": "boolean" }, "pst_code": { "type": "boolean" }, "cty_code": { "type": "boolean" } } }, "manufacturer": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "boolean" }, "name2": { "type": "boolean" }, "cr_uei_no": { "type": "boolean" }, "city": { "type": "boolean" }, "sbt_code": { "type": "boolean" }, "sbt_name": { "type": "boolean" }, "pst_code": { "type": "boolean" }, "cty_code": { "type": "boolean" } } } } }, "cargo": { "type": "object", "required": [], "additionalProperties": false, "properties": { "release_loc": { "type": "boolean" }, "receipt_loc": { "type": "boolean" }, "storage_loc": { "type": "boolean" }, "containers": { "type": "object" }, "blanket_start_date": { "type": "boolean" } } }, "in_trans": { "type": "object", "required": [], "additionalProperties": false, "properties": { "add_vess_info": { "type": "boolean" }, "arrival_date": { "type": "boolean" }, "cty_destn": { "type": "boolean" }, "cvy_ref_no": { "type": "boolean" }, "dept_date": { "type": "boolean" }, "discharge_port": { "type": "boolean" }, "loading_port": { "type": "boolean" }, "master_ship_doc": { "type": "boolean" }, "tpt_id": { "type": "boolean" }, "type": { "type": "boolean" } } }, "out_trans": { "type": "object", "required": [], "additionalProperties": false, "properties": { "add_vess_info": { "type": "boolean" }, "arrival_date": { "type": "boolean" }, "cty_destn": { "type": "boolean" }, "cvy_ref_no": { "type": "boolean" }, "dept_date": { "type": "boolean" }, "discharge_port": { "type": "boolean" }, "loading_port": { "type": "boolean" }, "master_ship_doc": { "type": "boolean" }, "tpt_id": { "type": "boolean" }, "type": { "type": "boolean" } } }, "ref_document": { "type": "object", "items": { "type": "object", "required": [], "additionalProperties": false, "properties": { "blanket_start_date": { "type": "boolean" }, "declaration_id": { "type": "boolean" }, "exhibit_temp_imp_end_date": { "type": "boolean" }, "exhibit_temp_imp_start_date": { "type": "boolean" }, "receipt_loc": { "type": "boolean" }, "release_loc": { "type": "boolean" }, "removal_start_date": { "type": "boolean" }, "storage_loc": { "type": "boolean" } } } }, "invoice": { "type": "object", "items": { "type": "object", "required": [], "additionalProperties": false, "properties": { "ad_valorem_ind": { "type": "boolean" }, "declaration_id": { "type": "boolean" }, "frc_charge": { "type": "boolean" }, "ins_charge": { "type": "boolean" }, "inv_date": { "type": "boolean" }, "inv_no": { "type": "boolean" }, "inv_term_type": { "type": "boolean" }, "oth_charge": { "type": "boolean" }, "pref_duty_date_ind": { "type": "boolean" }, "seq_no": { "type": "boolean" }, "sup_imp_relation": { "type": "boolean" }, "sup_mfr": { "type": "boolean" }, "tot_inv_amt": { "type": "boolean" } } } }, "items": { "type": "object", "items": { "type": "object", "required": [], "additionalProperties": false, "properties": { "id": { "type": "number" }, "alcohol_percent": { "type": "boolean" }, "brand": { "type": "boolean" }, "cif_fob_amt": { "type": "boolean" }, "cif_fob_fc": { "type": "boolean" }, "cty_origin": { "type": "boolean" }, "curr_lot_no": { "type": "boolean" }, "customs_duty": { "type": "boolean" }, "dangerous_goods_ind": { "type": "boolean" }, "declaration_id": { "type": "boolean" }, "dut_qty": { "type": "boolean" }, "excise_duty": { "type": "boolean" }, "gst_amt": { "type": "boolean" }, "gst_rate": { "type": "boolean" }, "hs_code": { "type": "boolean" }, "hs_qty": { "type": "boolean" }, "in_house_ship_doc": { "type": "boolean" }, "in_pack_qty": { "type": "boolean" }, "inmost_pack_qty": { "type": "boolean" }, "inner_pack_qty": { "type": "boolean" }, "item_cert": { "type": "boolean" }, "item_desc": { "type": "boolean" }, "item_inv_no": { "type": "boolean" }, "last_selling_price": { "type": "boolean" }, "marking": { "type": "boolean" }, "model": { "type": "boolean" }, "optional_item_charge": { "type": "boolean" }, "other_tax": { "type": "boolean" }, "out_house_ship_doc": { "type": "boolean" }, "out_pack_qty": { "type": "boolean" }, "pref_code": { "type": "boolean" }, "prev_lot_no": { "type": "boolean" }, "seq_no": { "type": "boolean" }, "shipping_marks": { "type": "boolean" }, "strategic_goods_ind": { "type": "boolean" }, "tot_dut_qty": { "type": "boolean" }, "unit_price": { "type": "boolean" } } } }, "cpc": { "type": "object", "items": { "type": "object", "required": [], "additionalProperties": false, "properties": { "custom_proc_code": { "type": "boolean" }, "group_no": { "type": "boolean" }, "codes": { "type": "object" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.clone" } }, "/regulatory-declarations/{id}/cpc": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertCustomsProcedureCodes", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Create a customs procedure codes successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "minItems": 1, "items": { "type": "object", "required": [ "custom_proc_code", "group_no" ], "properties": { "group_no": { "type": "number" }, "custom_proc_code": { "type": "string", "maxLength": 7, "codeMustExists": { "refCode": "ct_pc_code" } }, "codes": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryCustomsProcedureCodesExcluding_declaration_id-seq_no-group_no-custom_proc_code_" } } } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertCustomsProcedureCodes" } }, "/regulatory-declarations/{id}/documents": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertDocument", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Create a documents successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryDocumentsExcluding_declaration_id-seq_no-size_in_kilobyte_" } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertDocument" } }, "/regulatory-declarations/{id}/invoices/{invoice_id}": { "patch": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "updateInvoices", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Update a invoices successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "invoice_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addRegulatoryDeclarationsInvoiceSchema" } } }, "x-parameter-index": 2 }, "operationId": "RegulatoryDeclarationsController.updateInvoices" }, "delete": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "deleteInvoices", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Delete a invoices successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "invoice_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.deleteInvoices" } }, "/regulatory-declarations/{id}/invoices": { "post": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "createInvoices", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Create a invoices successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addRegulatoryDeclarationsInvoiceSchema" } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.createInvoices" }, "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findInvoices", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The list of invoices" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryInvoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.findInvoices" } }, "/regulatory-declarations/{id}/items/{item_id}": { "delete": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "deleteItems", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Delete a items successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "item_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.deleteItems" } }, "/regulatory-declarations/{id}/items": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertItems", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Create a items successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryItems" } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertItems" }, "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findItems", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The list of items" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryItems.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.findItems" } }, "/regulatory-declarations/{id}/parties": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertParty", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Create a party successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "declaring_agent": { "$ref": "#/components/schemas/addPartyWithoutAddressSchema" }, "freight_forwarder": { "$ref": "#/components/schemas/addPartyWithoutAddressSchema" }, "in_carrier_agent": { "$ref": "#/components/schemas/addPartyWithoutAddressSchema" }, "importer": { "$ref": "#/components/schemas/addPartyWithoutAddressSchema" }, "out_carrier_agent": { "$ref": "#/components/schemas/addPartyWithoutAddressSchema" }, "exporter": { "$ref": "#/components/schemas/addPartyWithAddressSchema" }, "consignee": { "$ref": "#/components/schemas/consigneeSchema" }, "claimant": { "$ref": "#/components/schemas/claimantSchema" }, "end_user": { "$ref": "#/components/schemas/addPartyEndUserWithAddressSchema" }, "manufacturer": { "$ref": "#/components/schemas/addPartyWithAddressSchema" } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertParty" } }, "/regulatory-declarations/{id}/submissions": { "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findHistorySubmissions", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "List histories submissions" } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatorySubmissionHistories.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.findHistorySubmissions" } }, "/regulatory-declarations/{id}/submit": { "post": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "submitDeclaration", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "Submit the regulatory declaration" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "dec_stmt_ind" ], "properties": { "dec_stmt_ind": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.submitDeclaration" } }, "/regulatory-declarations/{id}/transports": { "put": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "upsertTransport", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Create a transports successful" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryTransportsExcluding_id-declaration_id-type_" } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.upsertTransport" } }, "/regulatory-declarations/{id}": { "patch": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "updateById", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "RegulatoryDeclarations PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "flow_id": { "nullable": true, "type": "number" }, "bg_ind": { "type": "string", "maxLength": 3, "codeMustExists": true }, "pack_type": { "type": "string", "maxLength": 3, "codeMustExists": true }, "out_tpt_mode": { "nullable": true, "type": "number", "codeMustExists": true }, "in_tpt_mode": { "nullable": true, "type": "number", "codeMustExists": true }, "has_ref_docs": { "type": "boolean" }, "supply_ind": { "type": "boolean" }, "add_recipients": { "type": "array", "maxItems": 3, "items": { "type": "string", "format": "email" } }, "remarks": { "type": "array", "maxItems": 2, "items": { "type": "string", "maxLength": 512 } }, "licences": { "type": "array", "maxItems": 5, "items": { "type": "string", "maxLength": 35 } }, "tot_out_pack": { "type": "object", "additionalProperties": false, "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "nullable": true, "packFormat": true }, "qty_uom": { "type": "string", "nullable": true, "codeMustExists": { "refCode": "qty_uom" } } } }, "tot_gross_wt": { "type": "object", "additionalProperties": false, "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "nullable": true, "type": "number", "weightFormat": true }, "qty_uom": { "type": "string", "nullable": true, "codeMustExists": { "refCode": "qty_uom" } } } }, "tot_duty_tax": { "type": "object", "properties": { "tot_gst_amt": { "type": "number", "nullable": true, "currencyFormat": true }, "tot_excise_duty_amt": { "type": "number", "nullable": true, "currencyFormat": true }, "tot_customs_duty_amt": { "type": "number", "nullable": true, "currencyFormat": true }, "tot_other_tax_amt": { "type": "number", "nullable": true, "currencyFormat": true }, "tot_payable_amt": { "type": "number", "nullable": true, "currencyFormat": true } } }, "dec_stmt_ind": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "RegulatoryDeclarationsController.updateById" }, "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "findById", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "RegulatoryDeclarations model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegulatoryDeclarationsDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.findById" }, "delete": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "deleteById", "tags": [ "Regulatory Declarations" ], "responses": { "204": { "description": "RegulatoryDeclarations DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RegulatoryDeclarationsController.deleteById" } }, "/regulatory-declarations": { "post": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "create", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "The ID of new RegulatoryDeclarations", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "car_type", "dec_type", "pack_type" ], "additionalProperties": false, "properties": { "car_type": { "type": "string", "enum": [ "OUTDEC", "IPTDEC", "INPDEC" ] }, "dec_type": { "type": "string", "maxLength": 7, "decTypeMustExists": true }, "bg_ind": { "type": "string", "maxLength": 3, "codeMustExists": true }, "pack_type": { "type": "string", "maxLength": 3, "codeMustExists": true }, "out_tpt_mode": { "nullable": true, "type": "number", "codeMustExists": true }, "in_tpt_mode": { "nullable": true, "type": "number", "codeMustExists": true }, "has_ref_docs": { "type": "boolean" }, "supply_ind": { "type": "boolean" }, "add_recipients": { "type": "array", "maxItems": 3, "items": { "type": "string", "format": "email" } }, "remarks": { "type": "array", "maxItems": 2, "items": { "type": "string", "maxLength": 512 } } }, "allOf": [ { "if": { "properties": { "car_type": { "const": "IPTDEC" }, "dec_type": { "enum": [ "DUT", "GST", "DNG", "TCR", "TCE", "TCO", "TCI" ] } } }, "then": { "required": [ "in_tpt_mode" ] } }, { "if": { "properties": { "car_type": { "const": "INPDEC" }, "dec_type": { "enum": [ "APS", "GTR", "DES", "REX", "TCS" ] } } }, "then": { "required": [ "in_tpt_mode" ] } }, { "if": { "properties": { "car_type": { "const": "INPDEC" }, "dec_type": { "enum": [ "SFZ", "REX" ] } } }, "then": { "required": [ "out_tpt_mode" ] } }, { "if": { "properties": { "car_type": { "const": "OUTDEC" }, "dec_type": { "enum": [ "APS", "BKT", "DRT", "TCE", "TCI", "TCO", "TCR", "TCS" ] } } }, "then": { "required": [ "out_tpt_mode" ] } } ] } } } }, "operationId": "RegulatoryDeclarationsController.create" }, "get": { "x-controller-name": "RegulatoryDeclarationsController", "x-operation-name": "find", "tags": [ "Regulatory Declarations" ], "responses": { "200": { "description": "Array of RegulatoryDeclarations records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryDeclarationsDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RegulatoryDeclarations.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RegulatoryDeclarationsController.find" } }, "/regulatory-dropdown": { "get": { "x-controller-name": "RegulatoryController", "x-operation-name": "find", "tags": [ "Regulatory Calista Dropdown" ], "responses": { "200": { "description": "Array of CalistaDropdown records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalistaDropdown" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CalistaDropdown.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The calista dropdown code to query", "required": true, "name": "dropdown_code", "in": "query", "schema": { "type": "string" } } ], "operationId": "RegulatoryController.find" } }, "/reheatings/{id}/override": { "post": { "x-controller-name": "ReheatingController", "x-operation-name": "override", "tags": [ "Reheating" ], "responses": { "200": { "description": "The ID of new Reheating", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "number" }, "job_no": { "type": "number" }, "container_no": { "type": "string" }, "product_code": { "type": "string" }, "desired_temp": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_start_date": { "type": "string", "format": "date-time" }, "expected_end_date": { "type": "string", "format": "date-time" }, "actual_start_date": { "type": "string", "format": "date-time" }, "actual_end_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "progress": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "number" }, "modified_name": { "type": "string" }, "supervise_by": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "histories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "remarks": { "type": "string" }, "progress": { "type": "number" }, "actual_temp": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "ReheatingController.override" } }, "/reheatings/{id}": { "patch": { "x-controller-name": "ReheatingController", "x-operation-name": "updateById", "tags": [ "Reheating" ], "responses": { "204": { "description": "Reheating PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReheatingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-actual_start_date-system_actual_date-reheating_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "ReheatingController.updateById" }, "get": { "x-controller-name": "ReheatingController", "x-operation-name": "findById", "tags": [ "Reheating" ], "responses": { "200": { "description": "Reheating model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "number" }, "job_no": { "type": "number" }, "container_no": { "type": "string" }, "product_code": { "type": "string" }, "desired_temp": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_start_date": { "type": "string", "format": "date-time" }, "expected_end_date": { "type": "string", "format": "date-time" }, "actual_start_date": { "type": "string", "format": "date-time" }, "actual_end_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "progress": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "number" }, "modified_name": { "type": "string" }, "supervise_by": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "histories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "remarks": { "type": "string" }, "progress": { "type": "number" }, "actual_temp": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "ReheatingController.findById" } }, "/reheatings": { "get": { "x-controller-name": "ReheatingController", "x-operation-name": "find", "tags": [ "Reheating" ], "responses": { "200": { "description": "Array of Reheating records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "customer": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "contract_id": { "type": "number" }, "job_no": { "type": "number" }, "container_no": { "type": "string" }, "product_code": { "type": "string" }, "desired_temp": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "expected_start_date": { "type": "string", "format": "date-time" }, "expected_end_date": { "type": "string", "format": "date-time" }, "actual_start_date": { "type": "string", "format": "date-time" }, "actual_end_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "progress": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Reheating.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ReheatingController.find" } }, "/requests/{id}/comments": { "post": { "x-controller-name": "RequestController", "x-operation-name": "createComment", "tags": [ "Request" ], "responses": { "200": { "description": "request_discussions model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestDiscussionDtoExcluding_provider_company_id-requester_id-provider_id-requester_company_id-user_type-user_id-user_identifier-request_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "RequestController.createComment" }, "get": { "x-controller-name": "RequestController", "x-operation-name": "getComments", "tags": [ "Request" ], "responses": { "200": { "description": "Array of RequestDiscussion records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "user_type": { "type": "number" }, "user_type_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "request_discussion_user": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" } } } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RequestDiscussionDto.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RequestController.getComments" } }, "/requests/{id}/documents/{document_id}": { "delete": { "x-controller-name": "RequestController", "x-operation-name": "deleteDocumentById", "tags": [ "Request" ], "responses": { "204": { "description": "Remove a document from request." } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true }, { "name": "document_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RequestController.deleteDocumentById" } }, "/requests/{id}/documents": { "post": { "x-controller-name": "RequestController", "x-operation-name": "addDocumentToRequest", "tags": [ "Request" ], "responses": { "200": { "description": "The Array ID of new Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "number" } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestDocumentDto" } } } } } }, "x-parameter-index": 1 }, "operationId": "RequestController.addDocumentToRequest" } }, "/requests/{id}": { "patch": { "x-controller-name": "RequestController", "x-operation-name": "updateById", "tags": [ "Request" ], "responses": { "204": { "description": "Request PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestDtoPartialExcluding_provider_company_id-requester_persona_id-provider_persona_id-requester_company_id-requester_id-provider_id-requester_identifier-requester_company_identifier-provider_company_identifiers-document-discussions-documents-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "RequestController.updateById" }, "get": { "x-controller-name": "RequestController", "x-operation-name": "findById", "tags": [ "Request" ], "responses": { "200": { "description": "Request model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "requester": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "requester_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "country": { "type": "object", "properties": { "address": { "type": "string" } } } } }, "provider": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "provider_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "country": { "type": "object", "properties": { "address": { "type": "string" } } } } }, "requester_persona_id": { "type": "number" }, "provider_persona_id": { "type": "number" }, "remarks": { "type": "string" }, "quotation": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "discussions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "user_type": { "type": "number" }, "user_type_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "request_discussion_user": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } } } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "request_id": { "type": "number" }, "name": { "type": "string" }, "document": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RequestController.findById" }, "delete": { "x-controller-name": "RequestController", "x-operation-name": "deleteById", "tags": [ "Request" ], "responses": { "204": { "description": "Request DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "RequestController.deleteById" } }, "/requests": { "post": { "x-controller-name": "RequestController", "x-operation-name": "create", "tags": [ "Request" ], "responses": { "200": { "description": "The ID of new Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "number" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRequestDto" } } } }, "operationId": "RequestController.create" }, "get": { "x-controller-name": "RequestController", "x-operation-name": "find", "tags": [ "Request" ], "responses": { "200": { "description": "Array of Request records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "requester": { "type": "object", "properties": { "name": { "type": "string" } } }, "requester_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "provider": { "type": "object", "properties": { "name": { "type": "string" } } }, "provider_company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "requester_persona_id": { "type": "number" }, "provider_persona_id": { "type": "number" }, "remarks": { "type": "string" }, "quotation": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "discussions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "user_type": { "type": "number" }, "user_type_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "request_discussion_user": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } } } } } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Request.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The provider persona id to query: \n* `2` - ISO Tank Depot \n* `3` - Logistics Service Provider \n* `6` - Shipper \n* `8` - Trucking Company \n", "required": true, "name": "persona", "in": "query", "schema": { "type": "integer", "enum": [ 2, 3, 6, 8 ] } } ], "operationId": "RequestController.find" } }, "/roles": { "get": { "x-controller-name": "RoleController", "x-operation-name": "find", "tags": [ "Role" ], "responses": { "200": { "description": "Array of Role records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoleDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Role.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleController.find" } }, "/scan": { "post": { "x-controller-name": "ScanPmoController", "x-operation-name": "scan", "tags": [ "ScanPmoController" ], "responses": { "200": { "description": "Return value of ScanPmoController.scan" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "type" ], "properties": { "code": { "type": "string" }, "type": { "type": "string", "enum": [ "pmo", "equipment", "shipment" ] } } } } } }, "operationId": "ScanPmoController.scan" } }, "/shipment/assign-pmos-to-box": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "assignPmosToBox", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.assignPmosToBox" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.assignPmosToBox" } }, "/shipment/by-pmos": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "getByPMOs", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.getByPMOs" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.getByPMOs" } }, "/shipment/create-box-for-pmos": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "createBoxForPMOs", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.createBoxForPMOs" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.createBoxForPMOs" } }, "/shipment/export": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "exportShipment", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment export file", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "description": "Shipment status.", "required": false, "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "Pickup", "Picked", "Packed", "Rejected" ] } }, { "description": "The from date (YYYY-MM-DD).", "required": false, "name": "fromDate", "in": "query", "schema": { "type": "string", "example": "2026-08-15" } }, { "description": "The to date (YYYY-MM-DD).", "required": false, "name": "toDate", "in": "query", "schema": { "type": "string", "example": "2026-09-15" } }, { "description": "Filter shipments without boxes.", "required": false, "name": "emptyOnly", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ShipmentController.exportShipment" } }, "/shipment/generate-temporary-no": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "generateTemporaryNo", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.generateTemporaryNo" } }, "operationId": "ShipmentController.generateTemporaryNo" } }, "/shipment/pickup/save": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "savePickup", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.savePickup" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.savePickup" } }, "/shipment/save": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "save", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.save" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.save" } }, "/shipment/sync-box-pmos": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "syncBoxPMOs", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.syncBoxPMOs" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.syncBoxPMOs" } }, "/shipment/{temporaryNo}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getByTemporaryNo", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.getByTemporaryNo" } }, "parameters": [ { "name": "temporaryNo", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.getByTemporaryNo" } }, "/shipment": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "searchShipment", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.searchShipment" } }, "parameters": [ { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "description": "Shipment status.", "required": false, "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "Pickup", "Picked", "Packed", "Rejected" ] } }, { "description": "The from date (YYYY-MM-DD).", "required": false, "name": "fromDate", "in": "query", "schema": { "type": "string", "example": "2026-08-15" } }, { "description": "The to date (YYYY-MM-DD).", "required": false, "name": "toDate", "in": "query", "schema": { "type": "string", "example": "2026-09-15" } }, { "description": "Filter shipments without boxes.", "required": false, "name": "emptyOnly", "in": "query", "schema": { "type": "boolean" } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC).", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "temporary_no DESC" } } }, { "description": "Page number.", "required": false, "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "The number of items to return per page.", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 20 } } ], "operationId": "ShipmentController.searchShipment" } }, "/shipments/{temporaryNo}/shipment-no": { "put": { "x-controller-name": "ShipmentController", "x-operation-name": "updateShipmentNo", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.updateShipmentNo" } }, "parameters": [ { "name": "temporaryNo", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipment_no" ], "properties": { "shipment_no": { "type": "string" } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "ShipmentController.updateShipmentNo" } }, "/sla-configs/by-provider/{provider}": { "get": { "x-controller-name": "SlaConfigController", "x-operation-name": "getSlaConfigByProvider", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.getSlaConfigByProvider" } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "countryCode", "in": "query", "schema": { "type": "string" } } ], "operationId": "SlaConfigController.getSlaConfigByProvider" } }, "/sla-configs/calculate-deadline": { "post": { "x-controller-name": "SlaConfigController", "x-operation-name": "calculateDeadline", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.calculateDeadline" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "startDateTime" ], "properties": { "provider": { "type": "string", "description": "Provider/Forwarder name" }, "startDateTime": { "type": "string", "format": "date-time", "description": "Start date time" }, "countryCode": { "type": "string", "description": "Country code (optional)" } } } } } }, "operationId": "SlaConfigController.calculateDeadline" } }, "/sla-configs/providers/list": { "get": { "x-controller-name": "SlaConfigController", "x-operation-name": "getProvidersList", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.getProvidersList" } }, "operationId": "SlaConfigController.getProvidersList" } }, "/sla-configs/remaining-time": { "post": { "x-controller-name": "SlaConfigController", "x-operation-name": "getRemainingTime", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.getRemainingTime" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "deadline" ], "properties": { "deadline": { "type": "string", "format": "date-time" } } } } } }, "operationId": "SlaConfigController.getRemainingTime" } }, "/sla-configs/{id}": { "put": { "x-controller-name": "SlaConfigController", "x-operation-name": "updateSlaConfig", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.updateSlaConfig" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string" }, "sla_hours": { "type": "number" }, "include_weekend": { "type": "boolean" }, "include_public_holiday": { "type": "boolean" }, "country_code": { "type": "string" }, "description": { "type": "string" }, "is_active": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "SlaConfigController.updateSlaConfig" }, "get": { "x-controller-name": "SlaConfigController", "x-operation-name": "getSlaConfigById", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.getSlaConfigById" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SlaConfigController.getSlaConfigById" }, "delete": { "x-controller-name": "SlaConfigController", "x-operation-name": "deleteSlaConfig", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.deleteSlaConfig" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SlaConfigController.deleteSlaConfig" } }, "/sla-configs": { "post": { "x-controller-name": "SlaConfigController", "x-operation-name": "createSlaConfig", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.createSlaConfig" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "provider", "sla_hours" ], "properties": { "provider": { "type": "string", "description": "Provider/Forwarder name" }, "sla_hours": { "type": "number", "description": "SLA time in hours" }, "include_weekend": { "type": "boolean", "default": false }, "include_public_holiday": { "type": "boolean", "default": false }, "country_code": { "type": "string", "description": "Country code (e.g., VN, US)" }, "description": { "type": "string" } } } } } }, "operationId": "SlaConfigController.createSlaConfig" }, "get": { "x-controller-name": "SlaConfigController", "x-operation-name": "listSlaConfigs", "tags": [ "SlaConfigController" ], "responses": { "200": { "description": "Return value of SlaConfigController.listSlaConfigs" } }, "parameters": [ { "name": "countryCode", "in": "query", "schema": { "type": "string" } }, { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "SlaConfigController.listSlaConfigs" } }, "/templates/{form_id}": { "patch": { "x-controller-name": "CompanyDocumentController", "x-operation-name": "updateById", "tags": [ "Company Templates" ], "responses": { "204": { "description": "CompanyDocument PATCH success" } }, "parameters": [ { "name": "form_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDocumentDtoPartialExcluding_id-flow_id-company_id-feature_id-module_id-form_id-created_date-created_by-modified_date-modified_by_" } } }, "x-parameter-index": 1 }, "operationId": "CompanyDocumentController.updateById" }, "get": { "x-controller-name": "CompanyDocumentController", "x-operation-name": "findByFormId", "tags": [ "Company Templates" ], "responses": { "200": { "description": "The company documents", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "feature": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "module": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "status": { "type": "boolean" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "company_gate_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "title": { "type": "string" }, "company_gate_group_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "question": { "type": "string" } } } } } } } } } } } } }, "parameters": [ { "name": "form_id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "CompanyDocumentController.findByFormId" } }, "/templates": { "get": { "x-controller-name": "CompanyDocumentController", "x-operation-name": "find", "tags": [ "Company Templates" ], "responses": { "200": { "description": "Array of CompanyDocument records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "feature": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "module": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "status": { "type": "boolean" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompanyDocument.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompanyDocumentController.find" } }, "/timeline/by-pmos": { "post": { "x-controller-name": "TimelineController", "x-operation-name": "getTimelineByPmos", "tags": [ "TimelineController" ], "responses": { "200": { "description": "Return value of TimelineController.getTimelineByPmos" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "TimelineController.getTimelineByPmos" } }, "/timeline/pmo/{pmoId}/{status}": { "get": { "x-controller-name": "TimelineController", "x-operation-name": "getTimelineDetail", "tags": [ "TimelineController" ], "responses": { "200": { "description": "Return value of TimelineController.getTimelineDetail" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "status", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TimelineController.getTimelineDetail" } }, "/timeline/pmo/{pmoId}": { "get": { "x-controller-name": "TimelineController", "x-operation-name": "getTimelineByPmo", "tags": [ "TimelineController" ], "responses": { "200": { "description": "Return value of TimelineController.getTimelineByPmo" } }, "parameters": [ { "name": "pmoId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TimelineController.getTimelineByPmo" } }, "/timeline/summary": { "post": { "x-controller-name": "TimelineController", "x-operation-name": "getTimelineSummary", "tags": [ "TimelineController" ], "responses": { "200": { "description": "Return value of TimelineController.getTimelineSummary" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "TimelineController.getTimelineSummary" } }, "/trade-lanes/{id}/flow": { "put": { "x-controller-name": "TradeLaneController", "x-operation-name": "upsertFlow", "tags": [ "Trade Lane" ], "responses": { "200": { "204": { "description": "Reference Flow PUT success" }, "description": "The ID of reference flow", "content": { "application/json": { "schema": { "type": "object", "properties": { "ref_flow": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "personas", "journey_points" ], "properties": { "personas": { "type": "array", "items": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } } }, "journey_points": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "order": { "type": "number" }, "persona": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "order": { "type": "number" } } }, "actor": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } }, "name": { "type": "string", "maxLength": 100 }, "expected_date_info": { "type": "object", "required": [ "field_name", "adjustment" ], "properties": { "field_name": { "type": "string" }, "adjustment": { "type": "number" } } }, "personas": { "type": "array", "items": { "type": "object", "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } } }, "validator": { "type": "object", "nullable": true, "required": [ "persona_id", "order" ], "properties": { "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" } } }, "actions": { "type": "array", "items": { "type": "object", "required": [ "form_id" ], "properties": { "form_id": { "type": "number" }, "title": { "type": "string" } } } } } } }, "flow_status": { "type": "boolean", "default": false } } } } }, "description": "The request body for create or update the TradeLaneFlow.", "x-parameter-index": 1 }, "operationId": "TradeLaneController.upsertFlow" } }, "/trade-lanes/{id}": { "patch": { "x-controller-name": "TradeLaneController", "x-operation-name": "updateById", "tags": [ "Trade Lane" ], "responses": { "204": { "description": "TradeLane PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-company_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "TradeLaneController.updateById" }, "get": { "x-controller-name": "TradeLaneController", "x-operation-name": "findById", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "TradeLane model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "trade_lane_flow": { "type": "object", "properties": { "id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "personas": { "type": "array", "items": { "type": "object" } }, "journey_points": { "type": "array", "items": { "type": "object" } } } }, "flow_status": { "type": "boolean" }, "product": { "type": "string" }, "product_no": { "type": "string" }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string" }, "desired_temp": { "type": "number" }, "safety_data_sheet": { "type": "string" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string" }, "provisions": { "type": "string" }, "status": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" }, "flows": { "type": "object", "properties": { "name": { "type": "string" }, "step": { "type": "number" }, "status_name": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TradeLaneController.findById" }, "delete": { "x-controller-name": "TradeLaneController", "x-operation-name": "deleteById", "tags": [ "Trade Lane" ], "responses": { "204": { "description": "TradeLane DELETE success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TradeLaneController.deleteById" } }, "/trade-lanes": { "post": { "x-controller-name": "TradeLaneController", "x-operation-name": "create", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "The ID of new TradeLane", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTradeLaneDto" } } } }, "operationId": "TradeLaneController.create" }, "get": { "x-controller-name": "TradeLaneController", "x-operation-name": "find", "tags": [ "Trade Lane" ], "responses": { "200": { "description": "Array of TradeLane records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "product": { "type": "string" }, "product_no": { "type": "string" }, "persona": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" } } }, "journey_points": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "order": { "type": "number" }, "persona_id": { "type": "number" } } } }, "safety_data_sheet": { "type": "string" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "code": { "type": "string" }, "name": { "type": "string" } } }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string" }, "provisions": { "type": "string" }, "status": { "type": "boolean" }, "status_name": { "type": "boolean" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TradeLane.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "description": "The country id.", "required": false, "name": "country", "in": "query", "schema": { "type": "number" } } ], "operationId": "TradeLaneController.find" } }, "/trade-lanes-upload": { "post": { "x-controller-name": "TradeLaneController", "x-operation-name": "upload", "tags": [ "Trade Lane" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "TradeLaneController.upload" } }, "/transports/{id}": { "patch": { "x-controller-name": "TransportController", "x-operation-name": "updateById", "tags": [ "Transports" ], "responses": { "204": { "description": "Transport PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-driven_by-production_location_id-expected_arrival_time-actual_start_time-actual_end_time-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "TransportController.updateById" }, "get": { "x-controller-name": "TransportController", "x-operation-name": "findById", "tags": [ "Transports" ], "responses": { "200": { "description": "Transport model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportDto" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TransportController.findById" } }, "/transports": { "get": { "x-controller-name": "TransportController", "x-operation-name": "find", "tags": [ "Transports" ], "responses": { "200": { "description": "Array of Transport records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransportDto" } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Transport.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TransportController.find" } }, "/users/logout": { "post": { "x-controller-name": "UserController", "x-operation-name": "signout", "tags": [ "User" ], "responses": { "200": { "description": "" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expired": { "type": "boolean", "default": false } } } } } }, "operationId": "UserController.signout" } }, "/users/phone-by-email": { "get": { "x-controller-name": "UserController", "x-operation-name": "getPhoneByEmail", "tags": [ "User" ], "responses": { "200": { "description": "Get phone number by email", "content": { "application/json": { "schema": { "type": "object", "properties": { "phone": { "type": "string" } } } } } } }, "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserController.getPhoneByEmail" } }, "/users/{identifier}": { "patch": { "x-controller-name": "UserController", "x-operation-name": "updateByIdentifier", "tags": [ "User" ], "responses": { "204": { "description": "User PATCH success" } }, "parameters": [ { "name": "identifier", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "UserController.updateByIdentifier" }, "get": { "x-controller-name": "UserController", "x-operation-name": "findByIdentifier", "tags": [ "User" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "avatar": { "type": "string" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_admin_name": { "type": "string" }, "blockchain_status": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "login_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "activities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "feature_id": { "type": "string" }, "description": { "type": "string" }, "activity_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "name": "identifier", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "UserController.findByIdentifier" }, "delete": { "x-controller-name": "UserController", "x-operation-name": "deleteByIdentifier", "tags": [ "User" ], "responses": { "204": { "description": "User DELETE success" } }, "parameters": [ { "name": "identifier", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "UserController.deleteByIdentifier" } }, "/users": { "post": { "x-controller-name": "UserController", "x-operation-name": "create", "tags": [ "User" ], "responses": { "200": { "description": "The ID of new User", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUser" } } } }, "operationId": "UserController.create" }, "get": { "x-controller-name": "UserController", "x-operation-name": "find", "tags": [ "User" ], "responses": { "200": { "description": "Array of User records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "company": { "type": "object", "properties": { "name": { "type": "string" } } }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "avatar": { "type": "string" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string" }, "is_admin": { "type": "boolean" }, "is_admin_name": { "type": "string" }, "blockchain_status": { "type": "number" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "login_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserController.find" } }, "/vessels/{id}/override": { "post": { "x-controller-name": "VesselController", "x-operation-name": "override", "tags": [ "Vessel" ], "responses": { "200": { "description": "The ID of new Vessel", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "containers": { "type": "array", "items": { "type": "object", "properties": { "container_no": { "type": "string" }, "shipment": { "type": "string" }, "reference": { "type": "string" } } } }, "allowed_containers": { "type": "array", "items": { "type": "string" } }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "VesselController.override" } }, "/vessels/{id}/validate": { "patch": { "x-controller-name": "VesselController", "x-operation-name": "validate", "tags": [ "Vessel" ], "responses": { "200": { "description": "Add more files to Vessel" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "VesselController.validate" } }, "/vessels/{id}": { "patch": { "x-controller-name": "VesselController", "x-operation-name": "updateById", "tags": [ "Vessel" ], "responses": { "204": { "description": "Vessel PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VesselDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "VesselController.updateById" }, "get": { "x-controller-name": "VesselController", "x-operation-name": "findById", "tags": [ "Vessel" ], "responses": { "200": { "description": "Vessel model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "company": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "containers": { "type": "array", "items": { "type": "object", "properties": { "container_no": { "type": "string" }, "shipment": { "type": "string" }, "reference": { "type": "string" } } } }, "allowed_containers": { "type": "array", "items": { "type": "string" } }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "VesselController.findById" } }, "/vessels": { "get": { "x-controller-name": "VesselController", "x-operation-name": "find", "tags": [ "Vessel" ], "responses": { "200": { "description": "Array of Vessel records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "company_other_type": { "type": "number" }, "company_other": { "type": "object", "properties": { "identifier": { "type": "string" }, "name": { "type": "string" } } }, "flow_id": { "type": "number" }, "action_type": { "type": "number" }, "form_type": { "type": "number" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "modified_name": { "type": "string" } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Vessel.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "VesselController.find" } }, "/weighbridges/{id}/override": { "post": { "x-controller-name": "WeighbridgeController", "x-operation-name": "override", "tags": [ "Weighbridge" ], "responses": { "200": { "description": "The ID of new Weighbridge", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "order_no": { "type": "string" }, "ticket_no": { "type": "number" }, "delivery_note_no": { "type": "string" }, "description": { "type": "string" }, "entry_info": { "type": "object", "properties": { "entry_id": { "type": "number" }, "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number" } } }, "exit_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_exit": { "type": "string", "format": "date-time" }, "weight": { "type": "number" } } }, "net_weight": { "type": "number" }, "payment_type": { "type": "number" }, "amount": { "type": "number" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "payment_type_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "trucking_company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "field_name": { "type": "string" }, "s3_key": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "WeighbridgeController.override" } }, "/weighbridges/{id}/validate": { "patch": { "x-controller-name": "WeighbridgeController", "x-operation-name": "validate", "tags": [ "Weighbridge" ], "responses": { "200": { "description": "Add more files to Weighbridge" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "uri": { "type": "string" }, "reason": { "type": "string" } } } } } } } }, "x-parameter-index": 1 }, "operationId": "WeighbridgeController.validate" } }, "/weighbridges/{id}": { "patch": { "x-controller-name": "WeighbridgeController", "x-operation-name": "updateById", "tags": [ "Weighbridge" ], "responses": { "204": { "description": "Weighbridge PATCH success" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeighbridgeDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-ticket_no-trucking_company_id-order_no-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_" } } }, "x-parameter-index": 1 }, "operationId": "WeighbridgeController.updateById" }, "get": { "x-controller-name": "WeighbridgeController", "x-operation-name": "findById", "tags": [ "Weighbridge" ], "responses": { "200": { "description": "Weighbridge model instance", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "order_no": { "type": "string" }, "ticket_no": { "type": "number" }, "delivery_note_no": { "type": "string" }, "description": { "type": "string" }, "entry_info": { "type": "object", "properties": { "entry_id": { "type": "number" }, "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number" } } }, "exit_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_exit": { "type": "string", "format": "date-time" }, "weight": { "type": "number" } } }, "net_weight": { "type": "number" }, "payment_type": { "type": "number" }, "amount": { "type": "number" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "cancelled_action": { "type": "number" }, "cancelled_reason": { "type": "string" }, "payment_type_name": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "created_name": { "type": "string" }, "modified_name": { "type": "string" }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "trucking_company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "field_name": { "type": "string" }, "s3_key": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "WeighbridgeController.findById" } }, "/weighbridges": { "get": { "x-controller-name": "WeighbridgeController", "x-operation-name": "find", "tags": [ "Weighbridge" ], "responses": { "200": { "description": "Array of Weighbridge records on the platform.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "number" }, "has_more": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "order_no": { "type": "string" }, "ticket_no": { "type": "number" }, "delivery_note_no": { "type": "string" }, "net_weight": { "type": "number" }, "payment_type": { "type": "number" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "status_name": { "type": "string" }, "created_name": { "type": "string" }, "trucking_company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "company": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } } } }, "parameters": [ { "description": "The offset value.", "required": false, "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "description": "The number of items to return.\n If the limit greater than 100,\n it auto set to 100", "required": false, "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "description": "The sort query parameter as a list of fields to sort on (ASC or DESC)", "required": false, "name": "sort", "in": "query", "schema": { "type": "array", "uniqueItems": true, "items": { "type": "string", "example": "created_date ASC" } } }, { "description": "Search keywords.", "required": false, "name": "q", "in": "query", "schema": { "type": "string", "minimum": 1 } }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Weighbridge.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WeighbridgeController.find" } } }, "servers": [ { "url": "https://logchain.dirox.dev" } ], "components": { "schemas": { "CategoryDto": { "title": "CategoryDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "nullable": true }, "type": { "type": "number", "maxLength": 1, "default": 0 }, "type_detail": { "type": "array", "items": { "type": "number" } }, "granted_users": { "type": "array", "items": { "type": "number" } }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1, "nullable": false }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "name", "status", "created_date" ], "additionalProperties": false }, "CategoryDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "CategoryDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'created_by' | 'modified_by' | 'created_date' | 'modified_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'created_by', 'modified_by',\n 'created_date', 'modified_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "company_id": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "nullable": true }, "type": { "type": "number", "maxLength": 1, "default": 0 }, "type_detail": { "type": "array", "items": { "type": "number" } }, "granted_users": { "type": "array", "items": { "type": "number" } }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1, "nullable": false } }, "additionalProperties": false, "x-typescript-type": "Omit, 'created_by' | 'modified_by' | 'created_date' | 'modified_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "CompanyRegulatoryDto": { "title": "CompanyRegulatoryDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "uen": { "type": "string" }, "tradeweb_id": { "type": "string" }, "duration_start": { "type": "string", "format": "date-time" }, "duration_end": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "uen", "tradeweb_id" ], "additionalProperties": false }, "CompanyRegulatoryHistoriesDto": { "title": "CompanyRegulatoryHistoriesDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "company_regulatory_id": { "type": "number" }, "history_info": { "type": "object" }, "comment": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" } }, "required": [ "company_regulatory_id" ], "additionalProperties": false }, "NewCompany": { "title": "NewCompany", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewCompany',\n exclude: [\n 'main_contact_id', 'status',\n 'parent_company_id', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "required": [ "name", "address", "country_id", "google_map_link", "privacy_status", "main_contact", "persona_ids" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyDtoPartialExcluding_main_contact_id-parent_company_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "CompanyDtoPartialExcluding_main_contact_id-parent_company_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'main_contact_id' | 'parent_company_id' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: { partial: true, exclude: [ 'main_contact_id', 'parent_company_id', 'id', 'identifier', 'created_date', 'created_by', 'modified_date', 'modified_by', 'login_date', 'uri', 'version', 'hash', 'blockchain_tx' ] })", "properties": { "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2 ] }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'main_contact_id' | 'parent_company_id' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "CompanyLicenceDto": { "title": "CompanyLicenceDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "referrer_company_id": { "type": "number" }, "licence_id": { "type": "number" }, "licence_rate": { "type": "number", "maxLength": 1, "default": 0 }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "white_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "blue_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "start_date", "end_date" ], "additionalProperties": false }, "NewFlowDefault1": { "title": "NewFlowDefault1", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFlowDefault1', exclude: [ 'stats', 'step', 'flow_default_id', 'created_date', 'created_by', 'modified_date', 'modified_by' ] })", "properties": { "id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "nullable": true }, "company_access": { "type": "number", "description": "- (0) That means all companies can see this flow. Otherwise, this will be the company id." }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RegulatoryDeclarationsDto": { "title": "RegulatoryDeclarationsDto", "type": "object", "properties": { "id": { "type": "number" }, "transaction_id": { "type": "string" }, "status": { "type": "number" }, "calista_status": { "type": "string" }, "calista_job_no": { "type": "string" }, "message": { "type": "string" }, "message_version": { "type": "string" }, "seq_no": { "type": "number" }, "car_type": { "type": "string" }, "dec_type": { "type": "string" }, "pack_type": { "type": "string" }, "in_tpt_mode": { "type": "number" }, "out_tpt_mode": { "type": "number" }, "dec_stmt_ind": { "type": "boolean" }, "bg_ind": { "type": "string" }, "supply_ind": { "type": "boolean" }, "has_ref_docs": { "type": "boolean" }, "add_recipients": { "type": "array", "items": { "type": "string" } }, "remarks": { "type": "array", "items": { "type": "string" } }, "licences": { "type": "array", "items": { "type": "string" } }, "tot_item": { "type": "number" }, "tot_cif_fob_amt": { "type": "number" }, "tot_out_pack": { "type": "object", "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number" }, "qty_uom": { "type": "string" } } }, "tot_gross_wt": { "type": "object", "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number" }, "qty_uom": { "type": "string" } } }, "tot_duty_tax": { "type": "object", "required": [ "tot_gst_amt", "tot_excise_duty_amt", "tot_customs_duty_amt", "tot_other_tax_amt", "tot_payable_amt" ], "properties": { "tot_gst_amt": { "type": "number" }, "tot_excise_duty_amt": { "type": "number" }, "tot_customs_duty_amt": { "type": "number" }, "tot_other_tax_amt": { "type": "number" }, "tot_payable_amt": { "type": "number" } } }, "update_pmt_no": { "type": "string" }, "amendment": { "type": "object", "properties": { "ame_fields_count": { "type": "number" }, "sc_update_info": { "type": "object", "properties": { "update_summary": { "type": "object", "properties": { "code": { "type": "number" }, "type": { "type": "string" } } } } }, "pmt_val_ext_ind": { "type": "boolean" }, "ext_reason": { "type": "string" }, "ame_reason": { "type": "string" } } }, "declaration_file": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "submitted_date": { "type": "string", "format": "date-time" }, "submitted_by": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "confirmed_date": { "type": "string", "format": "date-time" }, "confirmed_by": { "type": "number" }, "company_id": { "type": "number" }, "flow_id": { "type": "number" }, "company_regulatory_id": { "type": "number" } }, "additionalProperties": false }, "RoleRightsDto": { "title": "RoleRightsDto", "type": "object", "properties": { "feature_id": { "type": "number" }, "create": { "type": "number", "enum": [ 0, 1 ] }, "retrieve": { "type": "number", "enum": [ 0, 1 ] }, "update": { "type": "number", "enum": [ 0, 1 ] }, "delete": { "type": "number", "enum": [ 0, 1 ] }, "validate": { "type": "number", "enum": [ 0, 1 ] }, "override": { "type": "number", "enum": [ 0, 1 ] } }, "required": [ "feature_id", "create", "retrieve", "update", "delete", "validate", "override" ], "additionalProperties": false }, "NewRole2": { "title": "NewRole2", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewRole2',\n exclude: [\n 'user_count', 'user_active',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "company_id": { "type": "number" }, "collar_type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "boolean" }, "private": { "type": "boolean" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "role_details": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRightsDto" } } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleDto": { "title": "RoleDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "collar_type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "boolean" }, "private": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "user_count": { "type": "number" }, "user_active": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "role_details": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRightsDto" } } }, "required": [ "name" ], "additionalProperties": false }, "RoleDtoPartialExcluding_user_count-user_active-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "RoleDtoPartialExcluding_user_count-user_active-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'user_count' | 'user_active' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'user_count', 'user_active',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "company_id": { "type": "number" }, "collar_type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "boolean" }, "private": { "type": "boolean" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "role_details": { "type": "array", "items": { "$ref": "#/components/schemas/RoleRightsDto" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'user_count' | 'user_active' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "ModuleDtoExcluding_access-description_": { "title": "ModuleDtoExcluding_access-description_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'access', 'description' ], authorize: { resource: '21', scopes: [ 'retrieve' ] } })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "boolean" } }, "required": [ "name", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "NewTradeLaneDtoWithCompanyId": { "title": "NewTradeLaneDtoWithCompanyId", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewTradeLaneDtoWithCompanyId',\n exclude: [\n 'created_name', 'modified_name',\n 'pol_country', 'pod_country',\n 'default_flow', 'flows',\n 'pod_name', 'pol_name',\n 'pol_country_id', 'pod_country_id',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "product": { "type": "string" }, "product_no": { "type": "string", "maxLength": 100, "nullable": true }, "cargo_type": { "type": "number", "maxLength": 2, "default": 1 }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string", "maxLength": 250, "nullable": true }, "desired_temp": { "type": "number", "nullable": true }, "safety_data_sheet": { "type": "string", "example": "documents/trade-lane/opma/documents.docx" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string", "nullable": true }, "provisions": { "type": "string", "nullable": true }, "status": { "type": "boolean", "default": false }, "trade_lane_flow_id": { "type": "number" }, "flow_status": { "type": "boolean", "default": false }, "company_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "required": [ "name", "product", "pol_code", "pod_code", "reta_from", "reta_to", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'created_name' | 'modified_name' | 'pol_country' | 'pod_country' | 'default_flow' | 'flows' | 'pod_name' | 'pol_name' | 'pol_country_id' | 'pod_country_id' | 'cargo_type' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'created_name', 'modified_name',\n 'pol_country', 'pod_country',\n 'default_flow', 'flows',\n 'pod_name', 'pol_name',\n 'pol_country_id', 'pod_country_id',\n 'cargo_type', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "product": { "type": "string" }, "product_no": { "type": "string", "maxLength": 100, "nullable": true }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string", "maxLength": 250, "nullable": true }, "desired_temp": { "type": "number", "nullable": true }, "safety_data_sheet": { "type": "string", "example": "documents/trade-lane/opma/documents.docx" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string", "nullable": true }, "provisions": { "type": "string", "nullable": true }, "status": { "type": "boolean", "default": false }, "trade_lane_flow_id": { "type": "number" }, "flow_status": { "type": "boolean", "default": false }, "company_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'created_name' | 'modified_name' | 'pol_country' | 'pod_country' | 'default_flow' | 'flows' | 'pod_name' | 'pol_name' | 'pol_country_id' | 'pod_country_id' | 'cargo_type' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "TradeLaneFlowDto": { "title": "TradeLaneFlowDto", "type": "object", "properties": { "id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "created_name": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modified_name": { "type": "string" }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false }, "NewUserWithCompanyId": { "title": "NewUserWithCompanyId", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewUserWithCompanyId',\n exclude: [\n 'sub', 'password',\n 'change_password', 'login_date',\n 'status', 'blockchain_status',\n 'blockchain_certificate', 'settings',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "company_id": { "type": "number" }, "name": { "type": "string" }, "role_id": { "type": "number" }, "avatar": { "type": "string", "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string", "format": "email", "transform": [ "toLowerCase" ] }, "language": { "type": "string", "transform": [ "toLowerCase" ] }, "is_admin": { "type": "boolean" }, "phone_number_verified": { "type": "boolean" }, "company_name": { "type": "string" }, "role_name": { "type": "string" }, "status_name": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "required": [ "company_id", "name", "role_id", "contact_number", "contact_email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "UserDtoPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "UserDtoPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'sub' | 'company_id' | 'password' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'settings' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'sub', 'company_id',\n 'password', 'change_password',\n 'blockchain_status', 'blockchain_certificate',\n 'settings', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "role_id": { "type": "number" }, "avatar": { "type": "string", "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string", "format": "email", "transform": [ "toLowerCase" ] }, "language": { "type": "string", "transform": [ "toLowerCase" ] }, "is_admin": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "phone_number_verified": { "type": "boolean" }, "company_name": { "type": "string" }, "role_name": { "type": "string" }, "status_name": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'sub' | 'company_id' | 'password' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'settings' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "RoleFilterDto": { "title": "RoleFilterDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "collar_type": { "type": "number", "enum": [ 0, 1, 2 ], "default": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "boolean" }, "private": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false }, "CompanyFilterDto": { "title": "CompanyFilterDto", "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "parent_company_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "main_contact_id": { "type": "number" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "timezone": { "type": "string" } }, "required": [ "identifier", "name", "address", "country_id", "google_map_link", "privacy_status", "created_date" ], "additionalProperties": false }, "BolDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-shipper_id-consignee_id-forwarding_agent_id-system_actual_date-company_identifier-expected_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "BolDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-shipper_id-consignee_id-forwarding_agent_id-system_actual_date-company_identifier-expected_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'shipper_id' | 'consignee_id' | 'forwarding_agent_id' | 'system_actual_date' | 'company_identifier' | 'expected_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_id', 'shipper_id',\n 'consignee_id', 'forwarding_agent_id',\n 'system_actual_date', 'company_identifier',\n 'expected_date', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "bol_no": { "type": "string" }, "place_of_issuance": { "type": "string", "nullable": true }, "booking_ref": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "consignee_identifier": { "type": "string" }, "shipper_identifier": { "type": "string" }, "forwarding_agent_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "report": { "type": "string" }, "additional_document": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'shipper_id' | 'consignee_id' | 'forwarding_agent_id' | 'system_actual_date' | 'company_identifier' | 'expected_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "BolDto": { "title": "BolDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "shipper_id": { "type": "number" }, "consignee_id": { "type": "number" }, "forwarding_agent_id": { "type": "number" }, "bol_no": { "type": "string" }, "place_of_issuance": { "type": "string", "nullable": true }, "booking_ref": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "company_identifier": { "type": "string" }, "consignee_identifier": { "type": "string" }, "shipper_identifier": { "type": "string" }, "forwarding_agent_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "report": { "type": "string" }, "additional_document": { "type": "string" } }, "required": [ "flow_id", "expected_date", "status" ], "additionalProperties": false }, "CargoTypeDto": { "title": "CargoTypeDto", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "boolean" } }, "required": [ "name", "status" ], "additionalProperties": false }, "CargoDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "CargoDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_identifier', 'company_id',\n 'company_other_id', 'system_actual_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "product_no": { "type": "string" }, "action_type": { "type": "number", "enum": [ 0, 1 ] }, "form_type": { "type": "number", "enum": [ 0, 1 ] }, "cargo_type": { "type": "number", "maxLength": 2, "default": 2 }, "containers": { "type": "array", "items": { "type": "object" } }, "shipper_reference": { "type": "string", "nullable": true }, "consignee_reference": { "type": "string", "nullable": true }, "freight_forwarder": { "type": "string", "nullable": true }, "container_collection_location": { "type": "string", "nullable": true }, "container_delivery_location": { "type": "string", "nullable": true }, "haulier_name": { "type": "string", "nullable": true }, "vehicle_registration_no": { "type": "string", "nullable": true }, "trailer_no": { "type": "string", "nullable": true }, "special_instructions": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/cargoes/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "CargoDto": { "title": "CargoDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "product_no": { "type": "string" }, "action_type": { "type": "number", "enum": [ 0, 1 ] }, "form_type": { "type": "number", "enum": [ 0, 1 ] }, "cargo_type": { "type": "number", "maxLength": 2, "default": 2 }, "containers": { "type": "array", "items": { "type": "object" } }, "shipper_reference": { "type": "string", "nullable": true }, "consignee_reference": { "type": "string", "nullable": true }, "freight_forwarder": { "type": "string", "nullable": true }, "container_collection_location": { "type": "string", "nullable": true }, "container_delivery_location": { "type": "string", "nullable": true }, "haulier_name": { "type": "string", "nullable": true }, "vehicle_registration_no": { "type": "string", "nullable": true }, "trailer_no": { "type": "string", "nullable": true }, "special_instructions": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "flow_action_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "company_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/cargoes/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "flow_id", "expected_date", "status", "hidden", "created_date" ], "additionalProperties": false }, "CollarTypeDto": { "title": "CollarTypeDto", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "boolean" } }, "required": [ "name", "status" ], "additionalProperties": false }, "CompanyDocumentDtoPartialExcluding_id-flow_id-company_id-feature_id-module_id-form_id-created_date-created_by-modified_date-modified_by_": { "title": "CompanyDocumentDtoPartialExcluding_id-flow_id-company_id-feature_id-module_id-form_id-created_date-created_by-modified_date-modified_by_", "type": "object", "description": "(tsType: Omit, 'id' | 'flow_id' | 'company_id' | 'feature_id' | 'module_id' | 'form_id' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by'>, schemaOptions: { partial: true, exclude: [ 'id', 'flow_id', 'company_id', 'feature_id', 'module_id', 'form_id', 'created_date', 'created_by', 'modified_date', 'modified_by' ] })", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "nullable": true }, "status": { "type": "boolean" }, "form_builder": { "type": "boolean", "nullable": true }, "form_detail": { "type": "object" }, "is_published": { "type": "boolean", "nullable": true }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "company_gate_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "title": { "type": "string" }, "flag": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ], "description": "INSERT, UPDATE, DELETE" }, "company_gate_group_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "question": { "type": "string" }, "flag": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ] } } } } } } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'flow_id' | 'company_id' | 'feature_id' | 'module_id' | 'form_id' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by'>" }, "CompanyDocumentDto": { "title": "CompanyDocumentDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "nullable": true }, "feature_id": { "type": "number" }, "module_id": { "type": "number" }, "status": { "type": "boolean" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "form_id": { "type": "number" }, "form_builder": { "type": "boolean", "nullable": true }, "form_detail": { "type": "object" }, "is_published": { "type": "boolean", "nullable": true }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "company_gate_groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "title": { "type": "string" }, "flag": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ], "description": "INSERT, UPDATE, DELETE" }, "company_gate_group_details": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "order": { "type": "number" }, "question": { "type": "string" }, "flag": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ] } } } } } } } }, "required": [ "name", "status" ], "additionalProperties": false }, "CompanyFieldDto": { "title": "CompanyFieldDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "field_name_db": { "type": "string" }, "field_name_xml": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "company_id", "field_name_db", "field_name_xml", "created_date" ], "additionalProperties": false }, "CompanyPartyDto": { "title": "CompanyPartyDto", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "company_persona_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "company_id", "company_persona_id", "created_date" ], "additionalProperties": false }, "CompanyRegulatory": { "title": "CompanyRegulatory", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "uen": { "type": "string" }, "tradeweb_id": { "type": "string" }, "duration_start": { "type": "string", "format": "date-time" }, "duration_end": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "uen", "tradeweb_id" ], "additionalProperties": false }, "CompanyPublicCreateDtoExcluding_id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "CompanyPublicCreateDtoExcluding_id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n partial: false,\n exclude: [\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "privacy_status": { "type": "boolean" }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "required": [ "name", "address", "country_id", "google_map_link", "privacy_status", "main_contact", "persona_ids" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompanyPublicCreateDto": { "title": "CompanyPublicCreateDto", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "privacy_status": { "type": "boolean" }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "required": [ "name", "address", "country_id", "google_map_link", "privacy_status", "main_contact", "persona_ids" ], "additionalProperties": false }, "CompanyDtoPartialExcluding_main_contact_id-status-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "CompanyDtoPartialExcluding_main_contact_id-status-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'main_contact_id' | 'status' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'main_contact_id', 'status',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "parent_company_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'main_contact_id' | 'status' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "CompanyDto": { "title": "CompanyDto", "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "parent_company_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "main_contact_id": { "type": "number" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "timezone": { "type": "string" }, "main_contact": { "type": "object", "required": [ "email", "name", "phone_number" ], "properties": { "name": { "type": "string" }, "phone_number": { "type": "string" }, "email": { "type": "string", "format": "email" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "persona_ids": { "type": "array", "items": { "type": "number", "minItems": 1 } } }, "required": [ "identifier", "name", "address", "country_id", "google_map_link", "privacy_status", "created_date", "main_contact", "persona_ids" ], "additionalProperties": false }, "CompanyLocation": { "title": "CompanyLocation", "type": "object", "properties": { "id": { "type": "number" }, "company_persona_id": { "type": "number" }, "company_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "timezone": { "type": "string" }, "coordinates": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "status": { "type": "boolean", "default": false } }, "required": [ "company_persona_id", "name", "address", "country_id", "google_map_link" ], "additionalProperties": false }, "DGDDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-company_id-is_pdf_created-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "DGDDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-company_id-is_pdf_created-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'company_id' | 'is_pdf_created' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'company_id',\n 'is_pdf_created', 'system_actual_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "form_type": { "type": "number", "enum": [ 0, 1 ] }, "transport_document_number": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "freight_forwarder_reference": { "type": "string", "maxLength": 100 }, "shipper_name": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "shipper_additional_information": { "type": "string" }, "consignee_name": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "consignee_additional_information": { "type": "string" }, "additional_handling_information": { "type": "string" }, "vessel_no": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "actual_date": { "type": "string", "format": "date-time" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pol_fullname_on_dgd": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "pod_fullname_on_dgd": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "destination": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "containers": { "type": "array", "items": { "type": "object" } }, "overall_info": { "type": "string", "nullable": false, "default": "" }, "container_vehicle_size_and_type": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "tare_mass": { "type": "number", "minimum": 0.01 }, "gross_mass_total": { "type": "number", "minimum": 0.01 }, "name_of_company": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "name_of_declarant": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "place": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "status_date": { "type": "string", "format": "date-time" }, "remarks": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time", "nullable": false, "default": "" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/dgds/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'company_id' | 'is_pdf_created' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "DGDDto": { "title": "DGDDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "form_type": { "type": "number", "enum": [ 0, 1 ] }, "transport_document_number": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "freight_forwarder_reference": { "type": "string", "maxLength": 100 }, "shipper_name": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "shipper_additional_information": { "type": "string" }, "consignee_name": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "consignee_additional_information": { "type": "string" }, "additional_handling_information": { "type": "string" }, "vessel_no": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "actual_date": { "type": "string", "format": "date-time" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pol_fullname_on_dgd": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "pod_fullname_on_dgd": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "destination": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "containers": { "type": "array", "items": { "type": "object" } }, "overall_info": { "type": "string", "nullable": false, "default": "" }, "container_vehicle_size_and_type": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "tare_mass": { "type": "number", "minimum": 0.01 }, "gross_mass_total": { "type": "number", "minimum": 0.01 }, "name_of_company": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "name_of_declarant": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "place": { "type": "string", "maxLength": 100, "nullable": false, "default": "" }, "status_date": { "type": "string", "format": "date-time" }, "remarks": { "type": "string" }, "expected_date": { "type": "string", "format": "date-time", "nullable": false, "default": "" }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/dgds/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "transport_document_number", "shipper_name", "consignee_name", "vessel_no", "pol_fullname_on_dgd", "pod_fullname_on_dgd", "destination", "overall_info", "container_vehicle_size_and_type", "name_of_company", "name_of_declarant", "place", "expected_date", "status", "hidden" ], "additionalProperties": false }, "DocumentDtoPartialExcluding_flow_id-company_id-system_actual_date-status_name-is_pdf_created-created_date-created_by-modified_date-modified_by-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "DocumentDtoPartialExcluding_flow_id-company_id-system_actual_date-status_name-is_pdf_created-created_date-created_by-modified_date-modified_by-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'company_id' | 'system_actual_date' | 'status_name' | 'is_pdf_created' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'company_id',\n 'system_actual_date', 'status_name',\n 'is_pdf_created', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "flow_action_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "name": { "type": "string", "maxLength": 100 }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "reason_for_updating": { "type": "string", "nullable": true }, "readonly": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "modifier": { "type": "object", "nullable": true }, "documents": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/documents/3f5a16c6-7cb3-4f11-b90e-2e5c98ce64da/documents.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'company_id' | 'system_actual_date' | 'status_name' | 'is_pdf_created' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "DocumentDto": { "title": "DocumentDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "name": { "type": "string", "maxLength": 100 }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "remarks": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "reason_for_updating": { "type": "string", "nullable": true }, "readonly": { "type": "boolean" }, "modified_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "modifier": { "type": "object", "nullable": true }, "documents": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/documents/3f5a16c6-7cb3-4f11-b90e-2e5c98ce64da/documents.pdf" } } }, "required": [ "name", "readonly" ], "additionalProperties": false }, "EirDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-delivered_company_id-received_company_id-delivered_by-received_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "EirDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-delivered_company_id-received_company_id-delivered_by-received_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'delivered_company_id' | 'received_company_id' | 'delivered_by' | 'received_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_id', 'customer_id',\n 'delivered_company_id', 'received_company_id',\n 'delivered_by', 'received_by',\n 'system_actual_date', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "contract_id": { "type": "string" }, "receipt_no": { "type": "string" }, "container_no": { "type": "string", "maxLength": 200 }, "driven_name": { "type": "string", "nullable": true }, "delivered_by_name_indirect": { "type": "string", "maxLength": 200 }, "received_by_name_indirect": { "type": "string", "maxLength": 200 }, "remarks": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "type": { "type": "number", "enum": [ 0, 1 ] }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "customer_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "received_company_identifier": { "type": "string" }, "delivered_by_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "receipt": { "type": "string", "example": "documents/eirs/d702ee3d-eae9-43f6-90b4-db7234544573/receipt.docx" }, "additional_document": { "type": "string", "example": "documents/eirs/d702ee3d-eae9-43f6-90b4-db7234544573/additional_document.docx" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'delivered_company_id' | 'received_company_id' | 'delivered_by' | 'received_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "EirDto": { "title": "EirDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "customer_id": { "type": "number" }, "delivered_company_id": { "type": "number" }, "received_company_id": { "type": "number" }, "contract_id": { "type": "string" }, "receipt_no": { "type": "string" }, "container_no": { "type": "string", "maxLength": 200 }, "driven_name": { "type": "string", "nullable": true }, "delivered_by": { "type": "number" }, "delivered_by_name_indirect": { "type": "string", "maxLength": 200 }, "received_by_name_indirect": { "type": "string", "maxLength": 200 }, "remarks": { "type": "string", "nullable": true }, "received_by": { "type": "number" }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "type": { "type": "number", "enum": [ 0, 1 ] }, "modified_by": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "customer_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "received_company_identifier": { "type": "string" }, "delivered_by_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "receipt": { "type": "string", "example": "documents/eirs/d702ee3d-eae9-43f6-90b4-db7234544573/receipt.docx" }, "additional_document": { "type": "string", "example": "documents/eirs/d702ee3d-eae9-43f6-90b4-db7234544573/additional_document.docx" } }, "required": [ "status" ], "additionalProperties": false }, "EntryRecordDtoPartialExcluding_type-driven_by-inspected_by-entry_id-entry_record_groups-is_pdf_created-pdf_attempt-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "EntryRecordDtoPartialExcluding_type-driven_by-inspected_by-entry_id-entry_record_groups-is_pdf_created-pdf_attempt-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'type' | 'driven_by' | 'inspected_by' | 'entry_id' | 'entry_record_groups' | 'is_pdf_created' | 'pdf_attempt' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'type', 'driven_by',\n 'inspected_by', 'entry_id',\n 'entry_record_groups', 'is_pdf_created',\n 'pdf_attempt', 'system_actual_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "flow_action_id": { "type": "number" }, "remark": { "type": "string", "nullable": true }, "inspection_result": { "type": "number", "enum": [ 0, 1 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "planned_activity": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "method": { "type": "number", "enum": [ 0, 1 ] }, "override_by_id": { "type": "number" }, "inspected": { "type": "object", "nullable": true }, "driven_by_identifier": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "answer": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "remark": { "type": "string" } } } }, "checklists": { "type": "array", "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } }, "ref_documents": { "type": "array", "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'type' | 'driven_by' | 'inspected_by' | 'entry_id' | 'entry_record_groups' | 'is_pdf_created' | 'pdf_attempt' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "EntryRecordDto": { "title": "EntryRecordDto", "type": "object", "properties": { "id": { "type": "number" }, "entry_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "type": { "type": "number", "enum": [ 0, 1 ] }, "remark": { "type": "string", "nullable": true }, "inspection_result": { "type": "number", "enum": [ 0, 1 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "planned_activity": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "driven_by": { "type": "number" }, "inspected_by": { "type": "number" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "method": { "type": "number", "enum": [ 0, 1 ] }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "inspected": { "type": "object", "nullable": true }, "entry_record_groups": { "type": "array", "items": { "type": "object", "required": [ "order", "title" ], "properties": { "order": { "type": "number" }, "title": { "type": "string" }, "entry_record_group_details": { "type": "array", "items": { "required": [ "order", "question", "remark", "answer" ], "type": "object", "properties": { "order": { "type": "number" }, "question": { "type": "string" }, "remark": { "type": "string" }, "answer": { "type": "number", "enum": [ 0, 1, 2, 3 ] } } } } } } }, "driven_by_identifier": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "answer": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "remark": { "type": "string" } } } }, "checklists": { "type": "array", "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } }, "ref_documents": { "type": "array", "items": { "type": "string", "example": "documents/entries/d702ee3d-eae9-43f6-90b4-db7234544573/checklist.pdf" } } }, "required": [ "type" ], "additionalProperties": false }, "FleetViewDto": { "title": "FleetViewDto", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "flow_id": { "type": "number" }, "trucking_company_id": { "type": "number" }, "expected_date": { "type": "string", "format": "date-time" }, "flow_status": { "type": "number" }, "live_status": { "type": "number" }, "customer_name": { "type": "string" }, "vehicle_no": { "type": "string" }, "delivered_by": { "type": "string" }, "driver_name": { "type": "string" }, "location_company_id": { "type": "number" }, "location_id": { "type": "number" }, "location_name": { "type": "string" }, "delivery_note": { "type": "string" }, "reason_for_change": { "type": "string" }, "address": { "type": "string" }, "google_map_link": { "type": "string" }, "coordinates": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "allowed_edit": { "type": "boolean" } }, "additionalProperties": false }, "VerificationView": { "title": "VerificationView", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "flow_journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "external_id": { "type": "number" }, "table_name": { "type": "string" }, "form_id": { "type": "number" }, "verification_id": { "type": "number", "nullable": true }, "verification_company_id": { "type": "number", "nullable": true }, "is_actor": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2, 3, 9 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "actions_name": { "type": "string" }, "verification_name": { "type": "string" }, "status_name": { "type": "string" } }, "required": [ "flow_id", "flow_journey_point_id", "flow_action_id", "form_id", "is_actor", "status" ], "additionalProperties": false }, "VerificationViewPartialExcluding_flow_id-flow_journey_point_id-flow_action_id-form_id-verification_id-is_actor-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "VerificationViewPartialExcluding_flow_id-flow_journey_point_id-flow_action_id-form_id-verification_id-is_actor-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'flow_journey_point_id' | 'flow_action_id' | 'form_id' | 'verification_id' | 'is_actor' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'flow_journey_point_id',\n 'flow_action_id', 'form_id',\n 'verification_id', 'is_actor',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "external_id": { "type": "number" }, "table_name": { "type": "string" }, "verification_company_id": { "type": "number", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3, 9 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "actions_name": { "type": "string" }, "verification_name": { "type": "string" }, "status_name": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'flow_journey_point_id' | 'flow_action_id' | 'form_id' | 'verification_id' | 'is_actor' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "FlowDto": { "title": "FlowDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_default_id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "company_id": { "type": "number" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "cargo_type": { "type": "number", "maxLength": 2, "default": 1 }, "consignment_num": { "type": "string", "maxLength": 100 }, "no_of_container": { "type": "number" }, "xml_expected_dates": { "type": "object" }, "name": { "type": "string", "maxLength": 200 }, "reference_1": { "type": "string", "maxLength": 100, "nullable": true }, "reference_2": { "type": "string", "maxLength": 100, "nullable": true }, "reference_3": { "type": "string", "maxLength": 100, "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "live_status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "stats": { "type": "object", "properties": { "groups": { "type": "number" }, "steps": { "type": "number" }, "forms": { "type": "number" }, "documents": { "type": "number" }, "personas": { "type": "number" } } }, "step": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "required": [ "step" ], "additionalProperties": false }, "FlowPersonaDto": { "title": "FlowPersonaDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "name": { "type": "string", "maxLength": 500 }, "persona_id": { "type": "number" }, "company_id": { "type": "number" }, "order": { "type": "number" }, "status": { "type": "number", "enum": [ 3, 4, 5, 6 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "validated_date": { "type": "string", "format": "date-time" }, "needed_info": { "type": "object" }, "modified_by": { "type": "number" } }, "additionalProperties": false }, "NewFlow1": { "title": "NewFlow1", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFlow1', exclude: [ 'stats', 'step', 'created_date', 'created_by', 'modified_date', 'modified_by', 'company_id' ] })", "properties": { "id": { "type": "number" }, "flow_default_id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "cargo_type": { "type": "number", "maxLength": 2, "default": 1 }, "consignment_num": { "type": "string", "maxLength": 100 }, "no_of_container": { "type": "number" }, "xml_expected_dates": { "type": "object" }, "name": { "type": "string", "maxLength": 200 }, "reference_1": { "type": "string", "maxLength": 100, "nullable": true }, "reference_2": { "type": "string", "maxLength": 100, "nullable": true }, "reference_3": { "type": "string", "maxLength": 100, "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "live_status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "pol_country": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "pod_country": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "LicenceDto": { "title": "LicenceDto", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "nullable": true, "maxLength": 500 }, "type": { "type": "number", "maxLength": 1, "default": 0 }, "is_monthly": { "type": "boolean" }, "monthly_rate": { "type": "number" }, "is_yearly": { "type": "boolean" }, "yearly_rate": { "type": "number" }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1, "nullable": false }, "company_referred": { "type": "number", "default": 0, "minimum": 0, "maximum": 25 }, "white_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "blue_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "company_referred_white_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "company_referred_blue_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "name", "status", "created_date" ], "additionalProperties": false }, "LicenceDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "LicenceDtoPartialExcluding_created_by-modified_by-created_date-modified_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'created_by' | 'modified_by' | 'created_date' | 'modified_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'created_by', 'modified_by',\n 'created_date', 'modified_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "type": "string", "nullable": true, "maxLength": 500 }, "type": { "type": "number", "maxLength": 1, "default": 0 }, "is_monthly": { "type": "boolean" }, "monthly_rate": { "type": "number" }, "is_yearly": { "type": "boolean" }, "yearly_rate": { "type": "number" }, "status": { "type": "number", "enum": [ 0, 1 ], "default": 1, "nullable": false }, "company_referred": { "type": "number", "default": 0, "minimum": 0, "maximum": 25 }, "white_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "blue_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "company_referred_white_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 }, "company_referred_blue_collar_users": { "type": "number", "default": 0, "minimum": 0, "maximum": 9999 } }, "additionalProperties": false, "x-typescript-type": "Omit, 'created_by' | 'modified_by' | 'created_date' | 'modified_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "LiftDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "LiftDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_identifier', 'company_id',\n 'company_other_id', 'delivered_company_id',\n 'delivered_by', 'supervise_by',\n 'system_actual_date', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "type": { "type": "number", "enum": [ 0, 1 ] }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "tare_weight": { "type": "number", "minimum": 0.01 }, "expected_weight": { "type": "number" }, "planned_activity": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ] }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/lifts/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "LiftDto": { "title": "LiftDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "company_other_id": { "type": "number" }, "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "delivered_company_id": { "type": "number" }, "delivered_by": { "type": "number" }, "supervise_by": { "type": "number" }, "type": { "type": "number", "enum": [ 0, 1 ] }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "tare_weight": { "type": "number", "minimum": 0.01 }, "expected_weight": { "type": "number" }, "planned_activity": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ] }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "flow_action_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "company_identifier": { "type": "string" }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/lifts/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "flow_id", "expected_date", "status", "created_date" ], "additionalProperties": false }, "LoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "LoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_identifier', 'company_id',\n 'company_other_id', 'delivered_company_id',\n 'delivered_by', 'supervise_by',\n 'system_actual_date', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "type": { "type": "number", "enum": [ 0, 1 ], "default": 0, "nullable": false }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "seals": { "type": "array", "items": { "type": "string" } }, "expected_weight": { "type": "number", "minimum": 0.01 }, "actual_weight": { "type": "number", "minimum": 0.01 }, "is_weight_safe": { "type": "boolean", "nullable": true }, "is_weight_in_contract": { "type": "boolean", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/loadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "LoadingDto": { "title": "LoadingDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "company_other_id": { "type": "number" }, "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "delivered_company_id": { "type": "number" }, "delivered_by": { "type": "number" }, "supervise_by": { "type": "number" }, "type": { "type": "number", "enum": [ 0, 1 ], "default": 0, "nullable": false }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "seals": { "type": "array", "items": { "type": "string" } }, "expected_weight": { "type": "number", "minimum": 0.01 }, "actual_weight": { "type": "number", "minimum": 0.01 }, "is_weight_safe": { "type": "boolean", "nullable": true }, "is_weight_in_contract": { "type": "boolean", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "flow_action_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "company_identifier": { "type": "string" }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/loadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "flow_id", "expected_date", "status", "created_date" ], "additionalProperties": false }, "OnLoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "OnLoadingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-delivered_company_id-delivered_by-supervise_by-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_identifier', 'company_id',\n 'company_other_id', 'delivered_company_id',\n 'delivered_by', 'supervise_by',\n 'system_actual_date', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "type": { "type": "number", "enum": [ 0, 1 ], "default": 0 }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number", "minimum": 0.01 }, "actual_weight": { "type": "number", "minimum": 0.01 }, "is_weight_safe": { "type": "boolean", "nullable": true }, "is_weight_in_contract": { "type": "boolean", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/onloadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'delivered_company_id' | 'delivered_by' | 'supervise_by' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "OnLoadingDto": { "title": "OnLoadingDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "company_other_id": { "type": "number" }, "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "delivered_company_id": { "type": "number" }, "delivered_by": { "type": "number" }, "supervise_by": { "type": "number" }, "type": { "type": "number", "enum": [ 0, 1 ], "default": 0 }, "vehicle_no": { "type": "string" }, "driven_name": { "type": "string", "nullable": true }, "tank_no": { "type": "string" }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "expected_weight": { "type": "number", "minimum": 0.01 }, "actual_weight": { "type": "number", "minimum": 0.01 }, "is_weight_safe": { "type": "boolean", "nullable": true }, "is_weight_in_contract": { "type": "boolean", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "flow_action_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "company_identifier": { "type": "string" }, "company_other_identifier": { "type": "string" }, "delivered_company_identifier": { "type": "string" }, "supervise_identifier": { "type": "string" }, "delivered_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/onloadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "flow_id", "expected_date", "status", "created_date" ], "additionalProperties": false }, "UserProfile": { "title": "UserProfile", "type": "object", "properties": { "name": { "type": "string" }, "avatar": { "type": "string", "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_email": { "type": "string", "format": "email", "transform": [ "toLowerCase" ] }, "contact_number": { "type": "string" }, "contact_number_overwrite": { "type": "boolean" } }, "required": [ "name", "contact_email", "contact_number" ], "additionalProperties": false }, "NotificationSetting": { "title": "NotificationSetting", "type": "object", "properties": { "email": { "type": "boolean" }, "sms": { "type": "boolean" }, "inapp": { "type": "boolean" } }, "additionalProperties": false, "minimum": 1, "minProperties": 1 }, "FilterSetting": { "title": "FilterSetting", "type": "object", "properties": { "location_id": { "type": "number" } }, "additionalProperties": false, "minimum": 1, "minProperties": 1 }, "UserSettingPartialExcluding_main_contact_id-status-sub-company_id-password-role_id-is_admin-change_password-blockchain_status-blockchain_certificate-name-avatar-contact_number-contact_email-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "UserSettingPartialExcluding_main_contact_id-status-sub-company_id-password-role_id-is_admin-change_password-blockchain_status-blockchain_certificate-name-avatar-contact_number-contact_email-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'main_contact_id' | 'status' | 'sub' | 'company_id' | 'password' | 'role_id' | 'is_admin' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'name' | 'avatar' | 'contact_number' | 'contact_email' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'main_contact_id', 'status',\n 'sub', 'company_id',\n 'password', 'role_id',\n 'is_admin', 'change_password',\n 'blockchain_status', 'blockchain_certificate',\n 'name', 'avatar',\n 'contact_number', 'contact_email',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "notification": { "$ref": "#/components/schemas/NotificationSetting" }, "custom_bar": { "type": "number" }, "filter": { "$ref": "#/components/schemas/FilterSetting" }, "received_expected_action": { "type": "boolean" }, "received_due_action": { "type": "boolean" }, "received_completed_action": { "type": "boolean" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'main_contact_id' | 'status' | 'sub' | 'company_id' | 'password' | 'role_id' | 'is_admin' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'name' | 'avatar' | 'contact_number' | 'contact_email' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "UserSetting": { "title": "UserSetting", "type": "object", "properties": { "notification": { "$ref": "#/components/schemas/NotificationSetting" }, "custom_bar": { "type": "number" }, "filter": { "$ref": "#/components/schemas/FilterSetting" }, "received_expected_action": { "type": "boolean" }, "received_due_action": { "type": "boolean" }, "received_completed_action": { "type": "boolean" } }, "required": [ "custom_bar" ], "additionalProperties": false }, "RegulatoryDashboardsDto": { "title": "RegulatoryDashboardsDto", "type": "object", "properties": { "id": { "type": "number" }, "seq_no": { "type": "number" }, "title": { "type": "string" }, "value": { "type": "string" }, "filters": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "maxLength": 50 }, "rule": { "type": "string", "maxLength": 50 }, "value": { "type": "string", "maxLength": 50 } } } }, "query": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "title", "value", "query" ], "additionalProperties": false }, "RegulatoryTransportsExcluding_id-declaration_id-type_": { "title": "RegulatoryTransportsExcluding_id-declaration_id-type_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'declaration_id', 'type' ] })", "properties": { "cvy_ref_no": { "type": "string" }, "tpt_id": { "type": "string" }, "master_ship_doc": { "type": "string" }, "arrival_date": { "type": "string", "format": "date-time" }, "loading_port": { "type": "string", "locodeMustExists": true }, "dept_date": { "type": "string", "format": "date-time" }, "discharge_port": { "type": "string", "locodeMustExists": true }, "cty_destn": { "type": "string" }, "add_vess_info": { "type": "object", "additionalProperties": false, "properties": { "vess_type": { "type": "string", "maxLength": 2 }, "nrt_value": { "type": "number" }, "vess_nat": { "type": "string", "maxLength": 2 }, "tow_vess": { "type": "object", "properties": { "voy_no": { "type": "string", "maxLength": 17 }, "vess_name": { "type": "string", "maxLength": 35 } } }, "next_port": { "type": "string", "maxLength": 5 }, "final_port": { "type": "string", "maxLength": 5 } } } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RegulatoryDocumentsExcluding_declaration_id-seq_no-size_in_kilobyte_": { "title": "RegulatoryDocumentsExcluding_declaration_id-seq_no-size_in_kilobyte_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'declaration_id', 'seq_no', 'size_in_kilobyte' ] })", "properties": { "id": { "type": "number" }, "type": { "type": "string", "codeMustExists": { "refCode": "doc_id" } }, "file_name": { "type": "string" }, "s3_uri": { "type": "string" } }, "required": [ "type", "file_name", "s3_uri" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RegulatoryCustomsProcedureCodesExcluding_declaration_id-seq_no-group_no-custom_proc_code_": { "title": "RegulatoryCustomsProcedureCodesExcluding_declaration_id-seq_no-group_no-custom_proc_code_", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'declaration_id', 'seq_no', 'group_no', 'custom_proc_code' ] })", "properties": { "id": { "type": "number" }, "process_code1": { "type": "string", "maxLength": 35 }, "process_code2": { "type": "string", "maxLength": 35 }, "process_code3": { "type": "string", "maxLength": 35 } }, "required": [ "process_code1" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RegulatoryInvoices": { "title": "RegulatoryInvoices", "type": "object", "properties": { "id": { "type": "number" }, "inv_no": { "type": "string" }, "inv_date": { "type": "string", "format": "date-time" }, "seq_no": { "type": "number" }, "sup_mfr": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 17 }, "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "cr_uei_no": { "type": "string", "maxLength": 17 } } }, "ad_valorem_ind": { "type": "boolean" }, "pref_duty_date_ind": { "type": "boolean" }, "sup_imp_relation": { "type": "string" }, "inv_term_type": { "type": "string" }, "tot_inv_amt": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number" }, "curr_code": { "type": "string", "maxLength": 3 }, "exc_rate": { "type": "number" }, "local_amount": { "type": "number" } } }, "frc_charge": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number" }, "curr_code": { "type": "string", "maxLength": 3 }, "exc_rate": { "type": "number" }, "percent": { "type": "number" }, "local_amount": { "type": "number" } } }, "ins_charge": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number" }, "curr_code": { "type": "string", "maxLength": 3 }, "exc_rate": { "type": "number" }, "percent": { "type": "number" }, "local_amount": { "type": "number" } } }, "oth_charge": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number" }, "curr_code": { "type": "string", "maxLength": 3 }, "exc_rate": { "type": "number" }, "percent": { "type": "number" }, "local_amount": { "type": "number" } } }, "declaration_id": { "type": "number" } }, "additionalProperties": false }, "FlowFilterDto": { "title": "FlowFilterDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_default_id": { "type": "number" }, "trade_lane_id": { "type": "number" }, "company_id": { "type": "number" }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "cargo_type": { "type": "number", "maxLength": 2, "default": 1 }, "consignment_num": { "type": "string", "maxLength": 100 }, "no_of_container": { "type": "number" }, "xml_expected_dates": { "type": "object" }, "name": { "type": "string", "maxLength": 200 }, "reference_1": { "type": "string", "maxLength": 100, "nullable": true }, "reference_2": { "type": "string", "maxLength": 100, "nullable": true }, "reference_3": { "type": "string", "maxLength": 100, "nullable": true }, "description": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "live_status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "stats": { "type": "object", "properties": { "groups": { "type": "number" }, "steps": { "type": "number" }, "forms": { "type": "number" }, "documents": { "type": "number" }, "personas": { "type": "number" } } }, "step": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" } }, "required": [ "step" ], "additionalProperties": false }, "CalistaDropdown": { "title": "CalistaDropdown", "type": "object", "properties": { "id": { "type": "number" }, "dropdown_code": { "type": "string" }, "parent_code": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "message": { "type": "string" }, "reference": { "type": "string" }, "hs_type": { "type": "string" }, "duty_type": { "type": "string" }, "hs_uom": { "type": "string" }, "created_date": { "type": "string", "format": "date-time" } }, "required": [ "dropdown_code" ], "additionalProperties": false }, "ReheatingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-actual_start_date-system_actual_date-reheating_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "ReheatingDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-actual_start_date-system_actual_date-reheating_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'actual_start_date' | 'system_actual_date' | 'reheating_id' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_id', 'customer_id',\n 'actual_start_date', 'system_actual_date',\n 'reheating_id', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "contract_id": { "type": "string" }, "job_no": { "type": "number" }, "container_no": { "type": "string" }, "product_code": { "type": "string" }, "desired_temp": { "type": "number" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "expected_start_date": { "type": "string", "format": "date-time" }, "expected_end_date": { "type": "string", "format": "date-time" }, "actual_end_date": { "type": "string", "format": "date-time" }, "progress": { "type": "number" }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "remarks": { "type": "string" }, "actual_temp": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'actual_start_date' | 'system_actual_date' | 'reheating_id' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "ReheatingDto": { "title": "ReheatingDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "customer_id": { "type": "number" }, "contract_id": { "type": "string" }, "job_no": { "type": "number" }, "container_no": { "type": "string" }, "product_code": { "type": "string" }, "desired_temp": { "type": "number" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "expected_start_date": { "type": "string", "format": "date-time" }, "expected_end_date": { "type": "string", "format": "date-time" }, "actual_start_date": { "type": "string", "format": "date-time" }, "actual_end_date": { "type": "string", "format": "date-time" }, "system_actual_date": { "type": "string", "format": "date-time" }, "progress": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "remarks": { "type": "string" }, "actual_temp": { "type": "number" } }, "required": [ "flow_id", "desired_temp", "status", "expected_start_date", "expected_end_date", "progress", "created_date", "modified_date" ], "additionalProperties": false }, "RequestDtoPartialExcluding_provider_company_id-requester_persona_id-provider_persona_id-requester_company_id-requester_id-provider_id-requester_identifier-requester_company_identifier-provider_company_identifiers-document-discussions-documents-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "RequestDtoPartialExcluding_provider_company_id-requester_persona_id-provider_persona_id-requester_company_id-requester_id-provider_id-requester_identifier-requester_company_identifier-provider_company_identifiers-document-discussions-documents-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'provider_company_id' | 'requester_persona_id' | 'provider_persona_id' | 'requester_company_id' | 'requester_id' | 'provider_id' | 'requester_identifier' | 'requester_company_identifier' | 'provider_company_identifiers' | 'document' | 'discussions' | 'documents' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'provider_company_id', 'requester_persona_id',\n 'provider_persona_id', 'requester_company_id',\n 'requester_id', 'provider_id',\n 'requester_identifier', 'requester_company_identifier',\n 'provider_company_identifiers', 'document',\n 'discussions', 'documents',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "remarks": { "type": "string" }, "quotation": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "provider_identifier": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'provider_company_id' | 'requester_persona_id' | 'provider_persona_id' | 'requester_company_id' | 'requester_id' | 'provider_id' | 'requester_identifier' | 'requester_company_identifier' | 'provider_company_identifiers' | 'document' | 'discussions' | 'documents' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "RequestDocumentDto": { "title": "RequestDocumentDto", "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string", "example": "documents/requests/3f5a16c6-7cb3-4f11-b90e-2e5c98ce64da/documents.pdf" } }, "required": [ "name", "document" ], "additionalProperties": false }, "NewRequestDto": { "title": "NewRequestDto", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRequestDto', exclude: [ 'provider_company_id', 'requester_id', 'provider_id', 'requester_company_id', 'request_id', 'requester_company_identifier', 'discussions', 'requester_identifier', 'id', 'identifier', 'created_date', 'created_by', 'modified_date', 'modified_by', 'login_date', 'uri', 'version', 'hash', 'blockchain_tx' ] })", "properties": { "remarks": { "type": "string" }, "quotation": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "requester_persona_id": { "type": "number" }, "provider_persona_id": { "type": "number", "enum": [ 2, 3, 6, 8 ] }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestDocumentDto" } }, "provider_identifier": { "type": "string" }, "provider_company_identifiers": { "type": "array", "items": { "type": "string" } } }, "required": [ "status", "requester_persona_id", "provider_company_identifiers" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "RequestDiscussionCreateDto": { "title": "RequestDiscussionCreateDto", "type": "object", "properties": { "user_identifier": { "type": "string" }, "comment": { "type": "string" } }, "additionalProperties": false }, "RequestDto": { "title": "RequestDto", "type": "object", "properties": { "id": { "type": "number" }, "remarks": { "type": "string" }, "quotation": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "provider_company_id": { "type": "number" }, "requester_persona_id": { "type": "number" }, "provider_persona_id": { "type": "number", "enum": [ 2, 3, 6, 8 ] }, "modified_by": { "type": "number" }, "requester_company_id": { "type": "number" }, "requester_id": { "type": "number" }, "provider_id": { "type": "number" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "discussions": { "type": "array", "items": { "$ref": "#/components/schemas/RequestDiscussionCreateDto" } }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestDocumentDto" } }, "provider_identifier": { "type": "string" }, "requester_identifier": { "type": "string" }, "requester_company_identifier": { "type": "string" }, "provider_company_identifiers": { "type": "array", "items": { "type": "string" } } }, "required": [ "status", "created_date", "modified_date", "requester_persona_id", "requester_company_identifier", "provider_company_identifiers" ], "additionalProperties": false }, "RequestDiscussionDtoExcluding_provider_company_id-requester_id-provider_id-requester_company_id-user_type-user_id-user_identifier-request_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "RequestDiscussionDtoExcluding_provider_company_id-requester_id-provider_id-requester_company_id-user_type-user_id-user_identifier-request_id-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n exclude: [\n 'provider_company_id', 'requester_id',\n 'provider_id', 'requester_company_id',\n 'user_type', 'user_id',\n 'user_identifier', 'request_id',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "comment": { "type": "string" } }, "required": [ "comment" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "NewTradeLaneDto": { "title": "NewTradeLaneDto", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewTradeLaneDto',\n exclude: [\n 'created_name', 'modified_name',\n 'pol_country', 'pod_country',\n 'default_flow', 'flows',\n 'pod_name', 'pol_name',\n 'pol_country_id', 'pod_country_id',\n 'company_id', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "product": { "type": "string" }, "product_no": { "type": "string", "maxLength": 100, "nullable": true }, "cargo_type": { "type": "number", "maxLength": 2, "default": 1 }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string", "maxLength": 250, "nullable": true }, "desired_temp": { "type": "number", "nullable": true }, "safety_data_sheet": { "type": "string", "example": "documents/trade-lane/opma/documents.docx" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string", "nullable": true }, "provisions": { "type": "string", "nullable": true }, "status": { "type": "boolean", "default": false }, "trade_lane_flow_id": { "type": "number" }, "flow_status": { "type": "boolean", "default": false }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "required": [ "name", "product", "pol_code", "pod_code", "reta_from", "reta_to", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-company_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "TradeLaneDtoPartialExcluding_created_name-modified_name-pol_country-pod_country-default_flow-flows-pod_name-pol_name-pol_country_id-pod_country_id-company_id-cargo_type-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'created_name' | 'modified_name' | 'pol_country' | 'pod_country' | 'default_flow' | 'flows' | 'pod_name' | 'pol_name' | 'pol_country_id' | 'pod_country_id' | 'company_id' | 'cargo_type' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'created_name', 'modified_name',\n 'pol_country', 'pod_country',\n 'default_flow', 'flows',\n 'pod_name', 'pol_name',\n 'pol_country_id', 'pod_country_id',\n 'company_id', 'cargo_type',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "product": { "type": "string" }, "product_no": { "type": "string", "maxLength": 100, "nullable": true }, "product_hazard_ids": { "type": "array", "items": { "type": "number" } }, "product_additional_information": { "type": "string", "maxLength": 250, "nullable": true }, "desired_temp": { "type": "number", "nullable": true }, "safety_data_sheet": { "type": "string", "example": "documents/trade-lane/opma/documents.docx" }, "pol_code": { "type": "string" }, "pod_code": { "type": "string" }, "reta_from": { "type": "number" }, "reta_to": { "type": "number" }, "equipment": { "type": "string", "nullable": true }, "provisions": { "type": "string", "nullable": true }, "status": { "type": "boolean", "default": false }, "trade_lane_flow_id": { "type": "number" }, "flow_status": { "type": "boolean", "default": false }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'created_name' | 'modified_name' | 'pol_country' | 'pod_country' | 'default_flow' | 'flows' | 'pod_name' | 'pol_name' | 'pol_country_id' | 'pod_country_id' | 'company_id' | 'cargo_type' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "TransportDto": { "title": "TransportDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "driven_by": { "type": "number" }, "production_location_id": { "type": "number" }, "expected_arrival_time": { "type": "string", "format": "date-time" }, "actual_start_time": { "type": "string", "format": "date-time" }, "actual_end_time": { "type": "string", "format": "date-time" }, "location_start": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "location_end": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "travel_time": { "type": "number" }, "travel_distance": { "type": "number" }, "travel_screenshot": { "type": "string" }, "status": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "driven_by_identifier": { "type": "string", "format": "uuid" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false }, "TransportDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-driven_by-production_location_id-expected_arrival_time-actual_start_time-actual_end_time-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "TransportDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-driven_by-production_location_id-expected_arrival_time-actual_start_time-actual_end_time-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'driven_by' | 'production_location_id' | 'expected_arrival_time' | 'actual_start_time' | 'actual_end_time' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_id', 'driven_by',\n 'production_location_id', 'expected_arrival_time',\n 'actual_start_time', 'actual_end_time',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "location_start": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "location_end": { "type": "object", "required": [ "lat", "long" ], "properties": { "lat": { "type": "number" }, "long": { "type": "number" } } }, "travel_time": { "type": "number" }, "travel_distance": { "type": "number" }, "travel_screenshot": { "type": "string" }, "status": { "type": "number", "enum": [ 1, 2, 3, 4 ] }, "pdf_attempt": { "type": "number" }, "driven_by_identifier": { "type": "string", "format": "uuid" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'driven_by' | 'production_location_id' | 'expected_arrival_time' | 'actual_start_time' | 'actual_end_time' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "NewUser": { "title": "NewUser", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'NewUser',\n exclude: [\n 'sub', 'company_id',\n 'password', 'change_password',\n 'login_date', 'status',\n 'blockchain_status', 'blockchain_certificate',\n 'settings', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "role_id": { "type": "number" }, "avatar": { "type": "string", "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string", "format": "email", "transform": [ "toLowerCase" ] }, "language": { "type": "string", "transform": [ "toLowerCase" ] }, "is_admin": { "type": "boolean" }, "phone_number_verified": { "type": "boolean" }, "company_name": { "type": "string" }, "role_name": { "type": "string" }, "status_name": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true } }, "required": [ "name", "role_id", "contact_number", "contact_email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "UserPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "UserPartialExcluding_sub-company_id-password-change_password-blockchain_status-blockchain_certificate-settings-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'sub' | 'company_id' | 'password' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'settings' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'sub', 'company_id',\n 'password', 'change_password',\n 'blockchain_status', 'blockchain_certificate',\n 'settings', 'id',\n 'identifier', 'created_date',\n 'created_by', 'modified_date',\n 'modified_by', 'login_date',\n 'uri', 'version',\n 'hash', 'blockchain_tx'\n ]\n})", "properties": { "name": { "type": "string" }, "role_id": { "type": "number" }, "avatar": { "type": "string", "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "contact_number": { "type": "string" }, "contact_email": { "type": "string", "format": "email", "transform": [ "toLowerCase" ] }, "language": { "type": "string", "transform": [ "toLowerCase" ] }, "is_admin": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "phone_number_verified": { "type": "boolean" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'sub' | 'company_id' | 'password' | 'change_password' | 'blockchain_status' | 'blockchain_certificate' | 'settings' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "VesselDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "VesselDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_identifier-company_id-company_other_id-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_identifier', 'company_id',\n 'company_other_id', 'system_actual_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "action_type": { "type": "number", "enum": [ 0, 1 ] }, "form_type": { "type": "number", "enum": [ 0, 1 ] }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "shipping_line": { "type": "string" }, "vessel": { "type": "string" }, "vessel_date": { "type": "string", "format": "date-time" }, "containers": { "type": "array", "items": { "type": "object" } }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "company_other_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/loadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_identifier' | 'company_id' | 'company_other_id' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "VesselDto": { "title": "VesselDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "company_id": { "type": "number" }, "company_other_id": { "type": "number" }, "company_other_type": { "type": "number", "enum": [ 0, 1 ] }, "order_no": { "type": "string" }, "product_no": { "type": "string" }, "action_type": { "type": "number", "enum": [ 0, 1 ] }, "form_type": { "type": "number", "enum": [ 0, 1 ] }, "pol_code": { "type": "string" }, "pol_name": { "type": "string" }, "pol_country_id": { "type": "number" }, "pod_code": { "type": "string" }, "pod_name": { "type": "string" }, "pod_country_id": { "type": "number" }, "shipping_line": { "type": "string" }, "vessel": { "type": "string" }, "vessel_date": { "type": "string", "format": "date-time" }, "containers": { "type": "array", "items": { "type": "object" } }, "remarks": { "type": "string", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "flow_action_id": { "type": "number" }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "company_identifier": { "type": "string" }, "company_other_identifier": { "type": "string" }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "attachments": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/loadings/d702ee3d-eae9-43f6-90b4-db7234544573/attachment.pdf" } } }, "required": [ "flow_id", "expected_date", "status", "hidden", "created_date" ], "additionalProperties": false }, "WeighbridgeDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-ticket_no-trucking_company_id-order_no-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_": { "title": "WeighbridgeDtoPartialExcluding_flow_id-journey_point_id-flow_action_id-is_pdf_created-company_id-customer_id-ticket_no-trucking_company_id-order_no-system_actual_date-id-identifier-created_date-created_by-modified_date-modified_by-login_date-uri-version-hash-blockchain_tx_", "type": "object", "description": "(tsType: Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'ticket_no' | 'trucking_company_id' | 'order_no' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>, schemaOptions: {\n partial: true,\n exclude: [\n 'flow_id', 'journey_point_id',\n 'flow_action_id', 'is_pdf_created',\n 'company_id', 'customer_id',\n 'ticket_no', 'trucking_company_id',\n 'order_no', 'system_actual_date',\n 'id', 'identifier',\n 'created_date', 'created_by',\n 'modified_date', 'modified_by',\n 'login_date', 'uri',\n 'version', 'hash',\n 'blockchain_tx'\n ]\n})", "properties": { "delivered_by": { "type": "number" }, "delivery_note_no": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "category": { "type": "number", "enum": [ "Entry", "Exit", 0, 1 ] }, "entry_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0.01 } } }, "exit_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_exit": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0.01 } } }, "net_weight": { "type": "number" }, "payment_type": { "type": "number", "enum": [ "Account", "Cash", 0, 1 ] }, "amount": { "type": "number", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "type": { "type": "number", "enum": [ 0, 1 ] }, "pdf_attempt": { "type": "number" }, "override_by_id": { "type": "number" }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "tickets": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/weighbridges/d702ee3d-eae9-43f6-90b4-db7234544573/ticket.pdf" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'flow_id' | 'journey_point_id' | 'flow_action_id' | 'is_pdf_created' | 'company_id' | 'customer_id' | 'ticket_no' | 'trucking_company_id' | 'order_no' | 'system_actual_date' | 'id' | 'identifier' | 'created_date' | 'created_by' | 'modified_date' | 'modified_by' | 'login_date' | 'uri' | 'version' | 'hash' | 'blockchain_tx'>" }, "WeighbridgeDto": { "title": "WeighbridgeDto", "type": "object", "properties": { "id": { "type": "number" }, "flow_id": { "type": "number" }, "journey_point_id": { "type": "number" }, "flow_action_id": { "type": "number" }, "company_id": { "type": "number" }, "customer_id": { "type": "number" }, "order_no": { "type": "string" }, "trucking_company_id": { "type": "number" }, "delivered_by": { "type": "number" }, "ticket_no": { "type": "number" }, "delivery_note_no": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "category": { "type": "number", "enum": [ "Entry", "Exit", 0, 1 ] }, "entry_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_entry": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0.01 } } }, "exit_info": { "type": "object", "properties": { "code": { "type": "string" }, "consec_no": { "type": "string" }, "date_exit": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "minimum": 0.01 } } }, "net_weight": { "type": "number" }, "payment_type": { "type": "number", "enum": [ "Account", "Cash", 0, 1 ] }, "amount": { "type": "number", "nullable": true }, "expected_date": { "type": "string", "format": "date-time" }, "actual_date": { "type": "string", "format": "date-time", "nullable": true }, "system_actual_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 1, 2, 3 ] }, "cancelled_action": { "type": "number", "nullable": true, "enum": [ 1, 2, 3 ] }, "cancelled_reason": { "type": "string", "nullable": true }, "type": { "type": "number", "enum": [ 0, 1 ] }, "created_date": { "type": "string", "format": "date-time" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "is_pdf_created": { "type": "boolean" }, "pdf_attempt": { "type": "number" }, "uri": { "type": "string" }, "version": { "type": "string" }, "hash": { "type": "string" }, "blockchain_tx": { "type": "string" }, "override_by_id": { "type": "number" }, "hidden": { "type": "boolean", "nullable": false, "default": false }, "creator": { "type": "object", "nullable": true }, "modifier": { "type": "object", "nullable": true }, "tickets": { "type": "array", "items": { "type": "string", "minItems": 1, "example": "documents/weighbridges/d702ee3d-eae9-43f6-90b4-db7234544573/ticket.pdf" } } }, "required": [ "flow_id", "expected_date", "status" ], "additionalProperties": false }, "CompanyCreatedFromCompanyAdminDto": { "title": "CompanyCreatedFromCompanyAdminDto", "type": "object", "properties": { "id": { "type": "number" }, "identifier": { "type": "string" }, "identifier_token": { "type": "string" }, "identifier_user_id": { "type": "number" }, "parent_company_id": { "type": "number" }, "name": { "type": "string" }, "address": { "type": "string" }, "country_id": { "type": "number" }, "google_map_link": { "type": "string" }, "logo": { "type": "string", "nullable": true, "example": "assets/eccbe50b-54cc-45f5-8692-76b11d080d71.png" }, "main_contact_id": { "type": "number" }, "contact_number": { "type": "array", "items": { "type": "string" } }, "contact_email": { "type": "array", "items": { "type": "string", "format": "email" } }, "tags": { "type": "array", "items": { "type": "string" } }, "services": { "type": "string", "nullable": true }, "privacy_status": { "type": "boolean" }, "regulatory_status": { "type": "boolean" }, "status": { "type": "number", "enum": [ 1, 2 ] }, "created_date": { "type": "string", "format": "date-time" }, "created_by": { "type": "number" }, "modified_date": { "type": "string", "format": "date-time" }, "modified_by": { "type": "number" }, "timezone": { "type": "string" } }, "required": [ "identifier", "name", "address", "country_id", "google_map_link", "privacy_status", "created_date" ], "additionalProperties": false }, "addRegulatoryDeclarationsInvoiceSchema": { "title": "addRegulatoryDeclarationsInvoiceSchema", "type": "object", "required": [ "inv_no", "inv_date" ], "properties": { "inv_no": { "type": "string" }, "inv_date": { "type": "string", "format": "date-time" }, "inv_term_type": { "type": "string", "codeMustExists": true }, "ad_valorem_ind": { "type": "boolean" }, "pref_duty_date_ind": { "type": "boolean" }, "sup_imp_relation": { "type": "string" }, "sup_mfr": { "type": "object", "additionalProperties": false, "properties": { "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "cr_uei_no": { "type": "string", "maxLength": 17 } } }, "tot_inv_amt": { "type": "object", "additionalProperties": false, "required": [ "amt", "curr_code", "exc_rate" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "oth_charge": { "type": "object", "additionalProperties": false, "required": [ "amt", "curr_code", "exc_rate" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "percent": { "type": "number", "percentFormat": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "frc_charge": { "type": "object", "additionalProperties": false, "required": [ "amt", "curr_code", "exc_rate" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "percent": { "type": "number", "percentFormat": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "ins_charge": { "type": "object", "additionalProperties": false, "required": [ "amt", "curr_code", "exc_rate" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "percent": { "type": "number", "percentFormat": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } } }, "additionalProperties": false }, "cascProductsSchema": { "title": "cascProductsSchema", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'declaration_id', 'item_id', 'seq_no' ], title: 'RegulatoryCascProducts' })", "properties": { "id": { "type": "number" }, "prod_code": { "type": "string", "maxLength": 17, "codeMustExists": { "refCode": "casc_code" } }, "prod_qty": { "type": "number", "applyPattern": { "pattern": {} } }, "prod_qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } }, "end_use_desc": { "type": "string", "maxLength": 256 }, "add_casc_code": { "type": "array", "maxItems": 50, "items": { "type": "object", "properties": { "casc_code1": { "type": "string", "maxLength": 35 }, "casc_code2": { "type": "string", "maxLength": 35 }, "casc_code3": { "type": "string", "maxLength": 35 } } } } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RegulatoryItems": { "title": "RegulatoryItems", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'declaration_id', 'seq_no' ], title: 'RegulatoryItems' })", "properties": { "id": { "type": "number" }, "hs_code": { "type": "string", "codeMustExists": true }, "item_desc": { "type": "string" }, "cty_origin": { "type": "string", "maxLength": 2, "codeMustExists": { "refCode": "country" } }, "brand": { "type": "string", "maxLength": 35 }, "model": { "type": "string", "maxLength": 35 }, "dangerous_goods_ind": { "type": "boolean" }, "strategic_goods_ind": { "type": "boolean" }, "out_pack_qty": { "type": "object", "required": [ "qty", "uom" ], "properties": { "qty": { "type": "number", "applyPattern": { "pattern": {} } }, "uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "in_pack_qty": { "type": "object", "required": [ "qty", "uom" ], "properties": { "qty": { "type": "number", "applyPattern": { "pattern": {} } }, "uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "inner_pack_qty": { "type": "object", "required": [ "qty", "uom" ], "properties": { "qty": { "type": "number", "applyPattern": { "pattern": {} } }, "uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "inmost_pack_qty": { "type": "object", "required": [ "qty", "uom" ], "properties": { "qty": { "type": "number", "applyPattern": { "pattern": {} } }, "uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "hs_qty": { "type": "object", "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "applyPattern": { "pattern": {} } }, "qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": true } } }, "tot_dut_qty": { "type": "object", "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "applyPattern": { "pattern": {} } }, "qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": true } } }, "dut_qty": { "type": "object", "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "applyPattern": { "pattern": {} } }, "qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": true } } }, "alcohol_percent": { "type": "number" }, "cif_fob_amt": { "type": "number", "currencyFormat": true }, "cif_fob_fc": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "item_inv_no": { "type": "string", "maxLength": 35 }, "unit_price": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "optional_item_charge": { "type": "object", "required": [ "amt", "curr_code" ], "properties": { "amt": { "type": "number", "currencyFormat": true }, "curr_code": { "type": "string", "maxLength": 3, "codeMustExists": true }, "exc_rate": { "type": "number", "exchangeRateFormat": true }, "local_amount": { "type": "number", "currencyFormat": true } } }, "last_selling_price": { "type": "number", "currencyFormat": true }, "item_cert": { "type": "object", "additionalProperties": false, "properties": { "cert_qty": { "type": "object", "additionalProperties": false, "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "applyPattern": { "pattern": {} } }, "qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "item_value": { "type": "number", "currencyFormat": true }, "cert_desc": { "type": "array", "maxItems": 10, "items": { "type": "string", "maxLength": 35 } }, "mfr_cost_stm_date": { "type": "string", "format": "date-time" }, "text_code": { "type": "string", "maxLength": 5 }, "text_qty": { "type": "object", "additionalProperties": false, "required": [ "qty_value", "qty_uom" ], "properties": { "qty_value": { "type": "number", "applyPattern": { "pattern": {} } }, "qty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } } } }, "inv_no": { "type": "string", "maxLength": 35 }, "inv_date": { "type": "string", "format": "date-time" }, "origin_criterion": { "type": "array", "maxItems": 3, "items": { "type": "string", "maxLength": 25 } }, "hs_code": { "type": "string", "maxLength": 10, "codeMustExists": true }, "content_percent": { "type": "number" } } }, "shipping_marks": { "type": "array", "items": { "type": "string", "maxLength": 17 } }, "curr_lot_no": { "type": "string", "maxLength": 30 }, "prev_lot_no": { "type": "string", "maxLength": 30 }, "marking": { "type": "string", "maxLength": 2 }, "in_house_ship_doc": { "type": "string", "maxLength": 35 }, "out_house_ship_doc": { "type": "string", "maxLength": 35 }, "pref_code": { "type": "string", "maxLength": 3 }, "gst_rate": { "type": "number", "applyPattern": { "pattern": {} } }, "gst_amt": { "type": "number", "currencyFormat": true }, "excise_duty": { "type": "object", "required": [ "duty_rate", "duty_uom", "duty_amt" ], "properties": { "duty_rate": { "type": "number", "applyPattern": { "pattern": {} } }, "duty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } }, "duty_amt": { "type": "number", "currencyFormat": true } } }, "customs_duty": { "type": "object", "required": [ "duty_rate", "duty_uom", "duty_amt" ], "properties": { "duty_rate": { "type": "number", "applyPattern": { "pattern": {} } }, "duty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } }, "duty_amt": { "type": "number", "currencyFormat": true } } }, "other_tax": { "type": "object", "required": [ "duty_rate", "duty_uom", "duty_amt" ], "properties": { "duty_rate": { "type": "number", "applyPattern": { "pattern": {} } }, "duty_uom": { "type": "string", "maxLength": 3, "codeMustExists": { "refCode": "qty_uom" } }, "duty_amt": { "type": "number", "currencyFormat": true } } }, "casc_products": { "type": "array", "maxItems": 5, "items": { "$ref": "#/components/schemas/cascProductsSchema" } } }, "required": [ "hs_code", "cty_origin", "hs_qty" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "addPartyWithoutAddressSchema": { "title": "addPartyWithoutAddressSchema", "type": "object", "properties": { "cr_uei_no": { "type": "string", "maxLength": 17 }, "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 } }, "required": [ "cr_uei_no", "name1" ], "additionalProperties": false }, "addPartyWithAddressSchema": { "title": "addPartyWithAddressSchema", "type": "object", "properties": { "cr_uei_no": { "type": "string", "maxLength": 17 }, "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "address1": { "type": "string", "maxLength": 35 }, "address2": { "type": "string", "maxLength": 35 }, "city": { "type": "string", "maxLength": 35 }, "sbt_code": { "type": "string" }, "sbt_name": { "type": "string", "maxLength": 35 }, "pst_code": { "type": "string", "maxLength": 9 }, "cty_code": { "type": "string", "codeMustExists": { "refCode": "country" }, "maxLength": 2 } }, "required": [ "cr_uei_no", "name1" ], "additionalProperties": false }, "consigneeSchema": { "title": "consigneeSchema", "type": "object", "properties": { "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "address1": { "type": "string", "maxLength": 35 }, "address2": { "type": "string", "maxLength": 35 }, "city": { "type": "string", "maxLength": 35 }, "sbt_code": { "type": "string" }, "sbt_name": { "type": "string", "maxLength": 35 }, "pst_code": { "type": "string", "maxLength": 9 }, "cty_code": { "type": "string", "codeMustExists": { "refCode": "country" }, "maxLength": 2 } }, "additionalProperties": false, "required": [ "name1", "address1", "cty_code" ] }, "claimantSchema": { "title": "claimantSchema", "type": "object", "additionalProperties": false, "properties": { "cr_uei_no": { "type": "string", "maxLength": 17 }, "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "extra_info": { "type": "object", "properties": { "person_name": { "type": "string", "maxLength": 100 }, "person_code": { "type": "string", "maxLength": 17 } } } } }, "addPartyEndUserWithAddressSchema": { "title": "addPartyEndUserWithAddressSchema", "type": "object", "properties": { "name1": { "type": "string", "maxLength": 50 }, "name2": { "type": "string", "maxLength": 50 }, "address1": { "type": "string", "maxLength": 35 }, "address2": { "type": "string", "maxLength": 35 }, "city": { "type": "string", "maxLength": 35 }, "sbt_code": { "type": "string" }, "sbt_name": { "type": "string", "maxLength": 35 }, "pst_code": { "type": "string", "maxLength": 9 }, "cty_code": { "type": "string", "codeMustExists": { "refCode": "country" }, "maxLength": 2 } }, "required": [ "name1" ], "additionalProperties": false } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "hmac": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "jwt": [], "hmac": [] } ] }