Idiomas

Este tema contém os padrões MDM para idiomas

Idiomas (language)

Descrição
Esta entidade padroniza os seguintes atributos de idiomas:
- Id
- nome
- sigla
- alfabeto

Estrutura dos Campos

Campo	Descrição	Tipo
id	data.id (identificador) do idioma	int
name	nome do idioma	string
abbrev	sigla do idioma	string
alphabet	alfabeto usado no idioma	string
dataIdentifier	identificador de unicidade da entidade	string

Como consultar ultima versão do schema da entidade

Produção	https://platform.nstech.com.br/api/mdm/schema/latestRevision/language
Homologação	https://dev.nstech.com.br/platform/api/mdm-stg/schema/latestRevision/language

Exemplo de retorno

Clique em "JSON"

{
    "statusCode": 200,
    "success": true,
    "message": "Success",
    "document": {
        "_id": "6408e4872fdf838348471edb",
        "entityType": "language",
        "revision": 3,
        "dataIdentifierSetup": [
            "name"
        ],
        "jsonSchema": {
            "title": "Language 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": "An integer value",
                    "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": "Language name.",
                            "$id": "#/properties/data/properties/name",
                            "type": "string",
                            "minLength": 1,
                            "maxLenght": 200
                        },
                        "abbrev": {
                            "title": "Abbreviation of Language type.",
                            "$id": "#/properties/data/properties/abbrev",
                            "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": {
                "language": {
                    "create": true,
                    "update": true,
                    "delete": true,
                    "view": true
                }
            }
        },
        "sensiblePropertiesPath": [],
        "effectiveDate": "2023-01-24T19:10:31.455Z",
        "status": true,
        "deleted": false
    }
}

Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate

Produção	https://platform.nstech.com.br/api/mdm/entities/language/queryByTemplate/all?page=1&limit=2
Homologação	https://dev.nstech.com.br/platform/api/mdm-stg/entities/language/queryByTemplate/all?page=1&limit=2

Exemplo de chamada ao endpoint (GET) usando “data id”

Produção https://platform.nstech.com.br/api/mdm/entities/dataId/language/4
Homologação https://dev.nstech.com.br/platform/api/mdm-stg/entities/dataId/language/4

Produção	https://platform.nstech.com.br/api/mdm/entities/dataId/language/4
Homologação	https://dev.nstech.com.br/platform/api/mdm-stg/entities/dataId/language/4

Exemplo de chamada ao endpoint (GET) usando “updatedAt”

Produção	https://platform.nstech.com.br/api/mdm/entities/language/queryByTemplate/updatedAt?updatedAtFrom=2022-10-16T00:25:00.000Z&updatedAtTo=2023-01-12T19:39:40.078Z
Homologação	https://dev.nstech.com.br/platform/api/mdm-stg/entities/language/queryByTemplate/updatedAt?updatedAtFrom=2022-10-16T00:25:00.000Z&updatedAtTo=2023-01-12T19:39:40.078Z

Exemplo de retorno

Clique em "JSON"

{
    "statusCode": 200,
    "success": true,
    "message": "Success",
    "document": [
        {
            "_id": "63700abace9d5627804d03ac",
            "entityType": "language",
            "revision": 1,
            "data": {
                "name": "Longe",
                "abbrev": "aa",
                "dataId": 1,
                "dataIdentifier": {
                    "name": "Longe"
                }
            },
            "createdAt": "2022-11-12T21:06:02.426Z",
            "deleted": false,
            "userCreator": "service-account-mdm",
            "updatedAt": "2022-11-12T21:06:02.426Z"
        },
        {
            "_id": "63700abcce9d5627804d03ae",
            "entityType": "language",
            "revision": 1,
            "data": {
                "name": "Abkhazian",
                "abbrev": "ab",
                "dataId": 2,
                "dataIdentifier": {
                    "name": "Abkhazian"
                }
            },
            "createdAt": "2022-11-12T21:06:04.033Z",
            "deleted": false,
            "userCreator": "service-account-mdm",
            "updatedAt": "2022-11-12T21:06:04.033Z"
        }
    ],
    "page": 1,
    "limit": 2,
    "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/language/queryByTemplate/all?page=2&limit=2"
}