Este tema contém os padrões MDM para modais de transporte
Modais de transporte (transportationType)
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do modal de transporte int name nome do modal de transporte string dataIdentifier identificador de unicidade da entidade string -
Descrição
Id e nome
Esta entidade padroniza os seguintes atributos de modais de transporte -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e48b2fdf838348471eeb", "entityType": "transportationType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "Transportation Type Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of transportation type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "transportationType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T18:50:51.570Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636fbd6edd04eb0288a17dbc", "entityType": "transportationType", "revision": 1, "data": { "name": "Transporte rodoviário", "dataId": 1, "dataIdentifier": { "name": "Transporte rodoviário" } }, "createdAt": "2022-11-12T15:36:14.101Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:36:14.101Z" }, { "_id": "636fbd77dd04eb0288a17dbe", "entityType": "transportationType", "revision": 1, "data": { "name": "Transporte ferroviário", "dataId": 2, "dataIdentifier": { "name": "Transporte ferroviário" } }, "createdAt": "2022-11-12T15:36:23.100Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:36:23.100Z" }, { "_id": "636fbd7edd04eb0288a17dc0", "entityType": "transportationType", "revision": 1, "data": { "name": "Transporte aéreo", "dataId": 3, "dataIdentifier": { "name": "Transporte aéreo" } }, "createdAt": "2022-11-12T15:36:30.241Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:36:30.241Z" }, { "_id": "636fbd86062b1fff9d9d0294", "entityType": "transportationType", "revision": 1, "data": { "name": "Transporte hidroviário", "dataId": 4, "dataIdentifier": { "name": "Transporte hidroviário" } }, "createdAt": "2022-11-12T15:36:38.098Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:36:38.098Z" }, { "_id": "636fbd90062b1fff9d9d0296", "entityType": "transportationType", "revision": 1, "data": { "name": "Transporte dutoviário", "dataId": 5, "dataIdentifier": { "name": "Transporte dutoviário" } }, "createdAt": "2022-11-12T15:36:48.272Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:36:48.272Z" } ], "page": 1, "limit": 100, "nextPageURL": "Last Page" }