APIs - Tutoriais

GetSubjects

38 views 21/06/2021 21/06/2021 alex-serodio 0

GetSubjects

Obtém os usuários e grupos conforme o tipo (usuário ou grupo).

Payload de entrada:

{
   "page": 0,                 // página a ser consultada (opcional)
   "pageSize": 0,             // quantidade de itens na página (opcional)
   "nameFilter": "string",    // filtro pelo nome (opcional)
   "type": "User",            // filtro por tipo. Pode ser User, Group, Role ou UserApp (opcional)
   "includeRemoved": true     // incluir usuários removidos (opcional)
}

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/workflow/queries/getSubjects" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'page': 1, 'pageSize': 5, 'nameFilter': 'Contrato', 'type': 'User', 'includeRemoved': true }"

Responses:

  • 200 OK
    {
       "subjects": [
          {
             "userCode": 0,          // código do responsável
             "name": "string",       // nome do responsável
             "subjectKind": "User"   // tipo do responsável. Pode ser User, Group, Role ou UserApp
          }
       ],
       "totalElements": 0,           // total de itens
       "totalPages": 0               // total de páginas
    }
  • 400 Bad Request: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente
    {
       "message": "Descrição do erro",
       "errorCode": "codigoDoErro",
       "reason": "BAD_REQUEST",
       "domain": "platform",
       "service": "workflow"
    }
  • 401 Unauthorized: Usuário ou senha inválido
    {
       "error_description": "Descrição do erro",
       "error": "codigo_do_erro"
    }

Este artigo foi útil para você?