Este tema contém os padrões MDM para meios de comunicação e medias sociais
Meios de comunicação (communicationType)
-
Descrição
Esta entidade padroniza os seguintes atributos de meios de comunicação:- Id
- nome
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do tipo de meio de comunicação int name nome do tipo de meio de comunicação string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4822fdf838348471eca", "entityType": "communicationType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "communicationType entity", "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 communication type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 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": { "communicationType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-24T19:11:20.184Z", "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": "636ffaa6cff33738b4078eb0", "entityType": "communicationType", "revision": 1, "data": { "name": "Celular", "dataId": 1, "dataIdentifier": { "name": "Celular" } }, "createdAt": "2022-11-12T19:57:26.099Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:57:26.099Z" }, { "_id": "636ffaafce9d5627804ced6f", "entityType": "communicationType", "revision": 1, "data": { "name": "Radio", "dataId": 2, "dataIdentifier": { "name": "Radio" } }, "createdAt": "2022-11-12T19:57:35.133Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:57:35.133Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/communicationType/queryByTemplate/all?page=2&limit=2" }
Mídias sociais (socialMedia)
-
Descrição
Esta entidade padroniza os seguintes atributos de mídias sociais:- Id
- nome
- logotipo
-
Estrutura dos Campos
Campo Descrição Tipo Link id data.id (identificador) da media social int name nome da media social string logotype Logotipo (imagem) da media social base 64 dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e48b2fdf838348471ee8", "entityType": "socialMedia", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "socialMedia", "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 social media type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 2, "maxLength": 200 }, "logotype": { "title": "Logotype of social media type.", "$id": "#/properties/data/properties/logotype", "type": "string" }, "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": { "socialMedia": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T18:31:27.524Z", "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": "636ffb0dce9d5627804ced74", "entityType": "socialMedia", "revision": 1, "data": { "name": "Discord", "dataId": 1, "dataIdentifier": { "name": "Discord" } }, "createdAt": "2022-11-12T19:59:09.383Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:59:09.383Z" }, { "_id": "636ffb18ce9d5627804ced76", "entityType": "socialMedia", "revision": 1, "data": { "name": "Facebook", "dataId": 2, "dataIdentifier": { "name": "Facebook" } }, "createdAt": "2022-11-12T19:59:20.223Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:59:20.223Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/socialMedia/queryByTemplate/all?page=2&limit=2" }