APIs

Profissões

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

Profissões (job)

  • Descrição
    Esta entidade padroniza os seguintes atributos de profissões:
    Id e nome

  • Estrutura dos Campos

    CampoDescriçãoTipoLink
    dataIdIdentificador da profissãoint
    namenome da profissãostring
    dataIdentifieridentificador de unicidade da entidadestring
  • Como consultar ultima versão do schema da entidade

    • Exemplo de retorno
      Clique em "JSON"
      
      {
          "statusCode": 200,
          "success": true,
          "message": "Success",
          "document": {
              "_id": "6408e4872fdf838348471eda",
              "entityType": "job",
              "revision": 3,
              "dataIdentifierSetup": [
                  "name"
              ],
              "jsonSchema": {
                  "title": "Job 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. 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": "Name of job type.",
                                  "$id": "#/properties/data/properties/name",
                                  "type": "string",
                                  "minLength": 1,
                                  "maxLenght": 40
                              },
                              "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": {
                      "job": {
                          "create": true,
                          "update": true,
                          "delete": true,
                          "view": true
                      }
                  }
              },
              "sensiblePropertiesPath": [],
              "effectiveDate": "2023-01-24T19:10:25.991Z",
              "status": true,
              "deleted": false
          }
      }
      
  • 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": "636fb3d4062b1fff9d9d0259",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Advogado",
                    "dataId": 1,
                    "dataIdentifier": {
                        "name": "Advogado"
                    }
                },
                "createdAt": "2022-11-12T14:55:16.325Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T14:55:16.325Z"
            },
            {
                "_id": "636fb3df062b1fff9d9d025b",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Analista",
                    "dataId": 2,
                    "dataIdentifier": {
                        "name": "Analista"
                    }
                },
                "createdAt": "2022-11-12T14:55:27.002Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T14:55:27.002Z"
            },
            {
                "_id": "636fb3e8062b1fff9d9d025d",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Arquiteto",
                    "dataId": 3,
                    "dataIdentifier": {
                        "name": "Arquiteto"
                    }
                },
                "createdAt": "2022-11-12T14:55:36.216Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T14:55:36.216Z"
            },
            {
                "_id": "636fb5c2dd04eb0288a17d79",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Comprador",
                    "dataId": 4,
                    "dataIdentifier": {
                        "name": "Comprador"
                    }
                },
                "createdAt": "2022-11-12T15:03:30.197Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:03:30.197Z"
            },
            {
                "_id": "636fb5cadd04eb0288a17d7b",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Contabilista",
                    "dataId": 5,
                    "dataIdentifier": {
                        "name": "Contabilista"
                    }
                },
                "createdAt": "2022-11-12T15:03:38.231Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:03:38.231Z"
            },
            {
                "_id": "636fb5d3dd04eb0288a17d7d",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Corretor de imóveis",
                    "dataId": 6,
                    "dataIdentifier": {
                        "name": "Corretor de imóveis"
                    }
                },
                "createdAt": "2022-11-12T15:03:47.960Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:03:47.960Z"
            },
            {
                "_id": "636fb5dcdd04eb0288a17d7f",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Corretor de seguros",
                    "dataId": 7,
                    "dataIdentifier": {
                        "name": "Corretor de seguros"
                    }
                },
                "createdAt": "2022-11-12T15:03:56.362Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:03:56.362Z"
            },
            {
                "_id": "636fb5e7dd04eb0288a17d81",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Desenvolvedor de software",
                    "dataId": 8,
                    "dataIdentifier": {
                        "name": "Desenvolvedor de software"
                    }
                },
                "createdAt": "2022-11-12T15:04:07.039Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:07.039Z"
            },
            {
                "_id": "636fb5ef062b1fff9d9d025f",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Despachante aduaneiro",
                    "dataId": 9,
                    "dataIdentifier": {
                        "name": "Despachante aduaneiro"
                    }
                },
                "createdAt": "2022-11-12T15:04:15.787Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:15.787Z"
            },
            {
                "_id": "636fb5fcdd04eb0288a17d83",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Diretor",
                    "dataId": 10,
                    "dataIdentifier": {
                        "name": "Diretor"
                    }
                },
                "createdAt": "2022-11-12T15:04:28.121Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:28.121Z"
            },
            {
                "_id": "636fb603062b1fff9d9d0261",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Economista",
                    "dataId": 11,
                    "dataIdentifier": {
                        "name": "Economista"
                    }
                },
                "createdAt": "2022-11-12T15:04:35.506Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:35.506Z"
            },
            {
                "_id": "636fb60ddd04eb0288a17d85",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Empresário",
                    "dataId": 12,
                    "dataIdentifier": {
                        "name": "Empresário"
                    }
                },
                "createdAt": "2022-11-12T15:04:45.298Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:45.298Z"
            },
            {
                "_id": "636fb616dd04eb0288a17d87",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Encarregado",
                    "dataId": 13,
                    "dataIdentifier": {
                        "name": "Encarregado"
                    }
                },
                "createdAt": "2022-11-12T15:04:54.606Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:04:54.606Z"
            },
            {
                "_id": "636fb61f062b1fff9d9d0263",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Engenheiro",
                    "dataId": 14,
                    "dataIdentifier": {
                        "name": "Engenheiro"
                    }
                },
                "createdAt": "2022-11-12T15:05:03.066Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:05:03.066Z"
            },
            {
                "_id": "636fb627062b1fff9d9d0265",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Estatístico",
                    "dataId": 15,
                    "dataIdentifier": {
                        "name": "Estatístico"
                    }
                },
                "createdAt": "2022-11-12T15:05:11.733Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:05:11.733Z"
            },
            {
                "_id": "636fb630062b1fff9d9d0267",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Gerente ou gestor",
                    "dataId": 16,
                    "dataIdentifier": {
                        "name": "Gerente ou gestor"
                    }
                },
                "createdAt": "2022-11-12T15:05:20.051Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:05:20.051Z"
            },
            {
                "_id": "636fb638062b1fff9d9d0269",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Jornalista",
                    "dataId": 17,
                    "dataIdentifier": {
                        "name": "Jornalista"
                    }
                },
                "createdAt": "2022-11-12T15:05:28.559Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:05:28.559Z"
            },
            {
                "_id": "636fb645062b1fff9d9d026b",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Leiloeiro",
                    "dataId": 18,
                    "dataIdentifier": {
                        "name": "Leiloeiro"
                    }
                },
                "createdAt": "2022-11-12T15:05:41.386Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:05:41.386Z"
            },
            {
                "_id": "636fb666062b1fff9d9d026d",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Militar",
                    "dataId": 19,
                    "dataIdentifier": {
                        "name": "Militar"
                    }
                },
                "createdAt": "2022-11-12T15:06:14.346Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:06:14.346Z"
            },
            {
                "_id": "636fb8e2dd04eb0288a17d89",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Motorista",
                    "dataId": 20,
                    "dataIdentifier": {
                        "name": "Motorista"
                    }
                },
                "createdAt": "2022-11-12T15:16:50.166Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:16:50.166Z"
            },
            {
                "_id": "636fb8ec062b1fff9d9d026f",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Pesquisador",
                    "dataId": 21,
                    "dataIdentifier": {
                        "name": "Pesquisador"
                    }
                },
                "createdAt": "2022-11-12T15:17:00.151Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:00.151Z"
            },
            {
                "_id": "636fb8f3dd04eb0288a17d8b",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Professor",
                    "dataId": 22,
                    "dataIdentifier": {
                        "name": "Professor"
                    }
                },
                "createdAt": "2022-11-12T15:17:07.669Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:07.669Z"
            },
            {
                "_id": "636fb8fd062b1fff9d9d0271",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional administrativo",
                    "dataId": 23,
                    "dataIdentifier": {
                        "name": "Profissional administrativo"
                    }
                },
                "createdAt": "2022-11-12T15:17:17.613Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:17.613Z"
            },
            {
                "_id": "636fb904062b1fff9d9d0273",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional da saúde",
                    "dataId": 24,
                    "dataIdentifier": {
                        "name": "Profissional da saúde"
                    }
                },
                "createdAt": "2022-11-12T15:17:24.324Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:24.324Z"
            },
            {
                "_id": "636fb90ddd04eb0288a17d8d",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional de marketing",
                    "dataId": 25,
                    "dataIdentifier": {
                        "name": "Profissional de marketing"
                    }
                },
                "createdAt": "2022-11-12T15:17:33.979Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:33.979Z"
            },
            {
                "_id": "636fb916062b1fff9d9d0275",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional de relações públicas",
                    "dataId": 26,
                    "dataIdentifier": {
                        "name": "Profissional de relações públicas"
                    }
                },
                "createdAt": "2022-11-12T15:17:42.530Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:42.530Z"
            },
            {
                "_id": "636fb91f062b1fff9d9d0277",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional de RH",
                    "dataId": 27,
                    "dataIdentifier": {
                        "name": "Profissional de RH"
                    }
                },
                "createdAt": "2022-11-12T15:17:51.151Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:51.151Z"
            },
            {
                "_id": "636fb926062b1fff9d9d0279",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional de TI",
                    "dataId": 28,
                    "dataIdentifier": {
                        "name": "Profissional de TI"
                    }
                },
                "createdAt": "2022-11-12T15:17:58.105Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:17:58.105Z"
            },
            {
                "_id": "636fb92fdd04eb0288a17d8f",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Profissional informal",
                    "dataId": 29,
                    "dataIdentifier": {
                        "name": "Profissional informal"
                    }
                },
                "createdAt": "2022-11-12T15:18:07.084Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:07.084Z"
            },
            {
                "_id": "636fb936dd04eb0288a17d91",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Psicólogo",
                    "dataId": 30,
                    "dataIdentifier": {
                        "name": "Psicólogo"
                    }
                },
                "createdAt": "2022-11-12T15:18:14.910Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:14.910Z"
            },
            {
                "_id": "636fb93edd04eb0288a17d93",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Publicitário",
                    "dataId": 31,
                    "dataIdentifier": {
                        "name": "Publicitário"
                    }
                },
                "createdAt": "2022-11-12T15:18:22.801Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:22.801Z"
            },
            {
                "_id": "636fb946062b1fff9d9d027b",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Químico",
                    "dataId": 32,
                    "dataIdentifier": {
                        "name": "Químico"
                    }
                },
                "createdAt": "2022-11-12T15:18:30.689Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:30.689Z"
            },
            {
                "_id": "636fb94fdd04eb0288a17d95",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Secretário",
                    "dataId": 33,
                    "dataIdentifier": {
                        "name": "Secretário"
                    }
                },
                "createdAt": "2022-11-12T15:18:39.243Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:39.243Z"
            },
            {
                "_id": "636fb957dd04eb0288a17d97",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Técnico",
                    "dataId": 34,
                    "dataIdentifier": {
                        "name": "Técnico"
                    }
                },
                "createdAt": "2022-11-12T15:18:47.448Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:47.448Z"
            },
            {
                "_id": "636fb95edd04eb0288a17d99",
                "entityType": "job",
                "revision": 1,
                "data": {
                    "name": "Vendedor",
                    "dataId": 35,
                    "dataIdentifier": {
                        "name": "Vendedor"
                    }
                },
                "createdAt": "2022-11-12T15:18:54.899Z",
                "deleted": false,
                "userCreator": "service-account-mdm",
                "updatedAt": "2022-11-12T15:18:54.899Z"
            }
        ],
        "page": 1,
        "limit": 100,
        "nextPageURL": "Last Page"
    }