Skip to main content

Pontos de extremidade de coleções

Pontos de extremidade de coleções e parâmetros

Criar uma nova coleção

Adicionar um usuário a uma coleção

Adicionar um insight a uma coleção

Adicionar um agendamento a uma coleção

Adicionar um fluxo de trabalho a uma coleção

Adicionar um grupo de usuários a uma coleção

Recuperar um registro de coleção

Recuperar registros de todas as coleções

Atualizar uma coleção existente

Atualizar permissões de usuário de uma coleção

Atualizar permissões do grupo de usuários de uma coleção

Remover um usuário de uma coleção

Remover um fluxo de trabalho de uma coleção

Remover um insight de uma coleção

Remover um agendamento de uma coleção

Remover um grupo de usuários de uma coleção

Excluir uma coleção

Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto .

Para obter mais informações sobre coleções, visite a página de ajuda Coleções .

Criar uma nova coleção

Para criar uma coleção, use o ponto de extremidade POST {baseURL}/v3/collections .

Nota

Somente administradores podem usar esse ponto de extremidade de API. O usuário da API autenticado deve ter a permissão "Criar coleções" para usar este ponto de extremidade, caso contrário o erro "401 Não autorizado" será retornado.

Parâmetros

  • contract (corpo): para criar uma nova coleção, o parâmetro "contract" é obrigatório. Especifique o seguinte para criar uma coleção:

    • name (cadeia de caracteres): obrigatório. Especifique um nome de coleção.

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting'

Adicionar um usuário a uma coleção

Para adicionar um usuário a uma coleção existente, use o ponto de extremidade POST {baseURL}/v3/collections/{collectionId}/users .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

082A8515AB7ADDAAD5B04255CF2AE567.png

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para especificar a coleção à qual pretende adicionar um usuário.

  • addUsersContract (corpo): obrigatório. Insira uma informação sobre os usuários e suas permissões. Especifique o seguinte para adicionar usuários a uma coleção:

    • userId (cadeia de caracteres): obrigatório. Especifique o ID de um usuário que você deseja adicionar a uma coleção.

    • expirationDate (cadeia de caracteres): opcional. Especifique a data de vencimento para que o usuário faça parte desta coleção. Insira a data e a hora no formato ISO8601 .

    • collectionsPermissions (corpo):

      • isAdmin (booleano): obrigatório. Especifique se o usuário deve ser administrador desta coleção.

      • canAddAssets (booleano): obrigatório. Especifique se o usuário pode adicionar ativos à coleção.

      • canUpdateAssets (booleano): obrigatório. Especifique se o usuário pode atualizar ativos na coleção.

      • canRemoveAssets (booleano): obrigatório. Especifique se o usuário pode remover ativos da coleção.

      • canAddUsers (booleano): opcional. Especifique se o usuário pode adicionar outros usuários à coleção.

      • canRemoveUsers (booleano): opcional. Especifique se o usuário pode remover usuários da coleção.

Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário . Quando nenhuma função está selecionada, o padrão é a função padrão, conforme especificado por um administrador do Server na interface de administrador .

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/users' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userId=61d80f862835728c94328082' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true' \ --data-urlencode 'expirationDate=2007-08-17T19:18:11.924Z'

Adicionar um insight a uma coleção

Para adicionar um insight a uma coleção existente, use o ponto de extremidade POST {baseURL}/v3/collections/{collectionId}/insights .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para especificar a coleção à qual adicionar um insight.

  • contract (corpo): obrigatório. Insira uma informação sobre o insight. Especifique o seguinte:

    • insightId (cadeia de caracteres): obrigatório. Especifique o ID do insight que você deseja adicionar à coleção.

Exemplo de solicitação: cUrl

curl --location --request POST 'http://localhost/webapi//v3/collections/472dfff22086458d935d4edf348a1e2b/insights' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'insightId=61d80f33452835728c94328082'

Adicionar um agendamento a uma coleção

Para adicionar um agendamento a uma coleção existente, use o ponto de extremidade POST {baseURL}/v3/collections/{collectionId}/schedules .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para especificar a coleção à qual adicionar um agendamento.

  • contract (corpo): obrigatório. Insira uma informação sobre o agendamento. Especifique o seguinte:

    • scheduleId (cadeia de caracteres): obrigatório. Especifique o ID do agendamento que deseja adicionar à coleção.

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'scheduleId=61d80f334528377728c94328082'

Adicionar um fluxo de trabalho a uma coleção

Para adicionar um fluxo de trabalho a uma coleção existente, use o ponto de extremidade POST {baseURL}/v3/collections/{collectionId}/workflows .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para especificar a coleção à qual adicionar um insight.

  • contract (corpo): obrigatório. Insira uma informação sobre os usuários e suas permissões. Especifique o seguinte:

    • workflowId (cadeia de caracteres): obrigatório. Especifique o ID do fluxo de trabalho que deseja adicionar à coleção.

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/workflows' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'workflowId=61d80f334223377728c9432'

Adicionar um grupo de usuários a uma coleção

Para adicionar um grupo de usuários a uma coleção existente, use o ponto de extremidade POST {baseURL}/v3/collections/{collectionId}/userGroups .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para especificar a coleção à qual deseja adicionar um grupo de usuários.

  • addUserGroupsContract (corpo): obrigatório. Insira uma informação sobre o grupo de usuários e suas permissões. Especifique o seguinte:

    • userGroupId (cadeia de caracteres): obrigatório. Especifique o ID de um grupo de usuários que você deseja adicionar a uma coleção.

    • expirationDate (cadeia de caracteres): opcional. Especifique a data de vencimento para que o grupo de usuários faça parte desta coleção. Insira a data e a hora após as quais o fluxo de trabalho foi criado em formato ISO8601.

    • collectionsPermissions (corpo): obrigatório.

      • isAdmin (booleano): opcional. Especifique se os membros do grupo de usuários devem ser administradores desta coleção. O padrão é "false" (falso).

      • canAddAssets (booleano): opcional. Especifique se os membros do grupo de usuários podem adicionar ativos à coleção. O padrão é "false" (falso).

      • canRemoveAssets (booleano): opcional. Especifique se os membros do grupo de usuários podem remover ativos da coleção. O padrão é "false" (falso).

      • canUpdateAssets (booleano): opcional. Especifique se os membros do grupo de usuários podem atualizar ativos na coleção. O padrão é "false" (falso).

      • canAddUsers (booleano): opcional. Especifique se os membros do grupo de usuários podem adicionar outros usuários à coleção. O padrão é "false" (falso).

      • canRemoveUsers (booleano): obrigatório. Especifique se os membros do grupo de usuários podem remover outros usuários da coleção. O padrão é "false" (falso).

Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário . Quando nenhuma função está selecionada, o padrão é a função padrão, conforme especificado por um administrador do Server na interface de administrador .

Exemplo de solicitação: cURL

curl --location --request POST 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/userGroups?addUserGroupsContract' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'userGroupId=61d83e2ef778247f14e8e6b6' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=false' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=false' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Recuperar um registro de coleção

Para recuperar detalhes sobre uma coleção existente, use o ponto de extremidade GET {baseURL}/v3/collections/{collectionId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira um ID de coleção para obter as informações sobre a coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Recuperar registros de todas as coleções

Para recuperar todos os registros de coleção acessíveis, use o ponto de extremidade GET {baseURL}/v3/collections .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode escolher entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/collections?view=Full' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Atualizar uma coleção existente

Para atualizar o nome e/ou o proprietário de uma coleção existente, use o ponto de extremidade PUT {baseURL}/v3/collections/{collectionId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • updateCollectionContract (corpo): obrigatório. Insira informações sobre o proprietário da coleção que você deseja alterar. Especifique o seguinte:

    • name (cadeia de caracteres): obrigatório. Insira o novo nome da coleção.

    • ownerId (cadeia de caracteres): obrigatório. Insira o ID do novo proprietário.

Exemplo de solicitação: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'ownerId=61db388fc565144387d45086'

Atualizar permissões de usuário de uma coleção

Para atualizar as permissões de usuário dentro de uma coleção existente, use o ponto de extremidade PUT {baseURL}/v3/collections/{collectionId}/users/{userId}/permissions .

Nota

Somente administradores podem usar esse ponto de extremidade de API. Para instâncias do Server configuradas para autenticação do Windows, forneça o Sid do Active Directory para o parâmetro "userId".

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • userId (cadeia de caracteres): obrigatório. Insira o ID do usuário para o qual deseja alterar as permissões.

  • updatePermissionsContract (corpo): obrigatório. Insira o ID do usuário para o qual deseja alterar permissões. Especifique o seguinte:

    • expirationDate (data): obrigatório. Especifique a data de vencimento de um usuário.

    • collectionsPermissions (corpo): obrigatório. Insira o ID do usuário do novo proprietário. Especifique o seguinte:

      • isAdmin (booleano): obrigatório. Especifique se o usuário deve ser administrador desta coleção.

      • canAddAssets (booleano): obrigatório. Especifique se o usuário pode adicionar ativos à coleção.

      • canRemoveAssets (booleano): obrigatório. Especifique se o usuário pode remover ativos da coleção.

      • canUpdateAssets (booleano): obrigatório. Especifique se o usuário pode atualizar ativos na coleção.

      • canAddUsers (booleano): obrigatório. Especifique se o usuário pode adicionar outros usuários à coleção.

      • canRemoveUsers (booleano): obrigatório. Especifique se o usuário pode remover outros usuários da coleção.

Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário . Quando nenhuma função está selecionada, o padrão é a função padrão, conforme especificado por um administrador do Server na interface de administrador .

Exemplo de solicitação: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=true' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Atualizar permissões do grupo de usuários de uma coleção

Para atualizar permissões de um grupo de usuários dentro de uma coleção existente, use o ponto de extremidade PUT {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId}/permissions .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários para o qual deseja alterar as permissões.

  • updatePermissionsContract (corpo): obrigatório. Insira o ID do grupo de usuários para o qual deseja alterar permissões. Especifique o seguinte:

    • expirationDate (data): opcional. Especifique a data de vencimento para um grupo de usuários.

    • collectionsPermissions (corpo): obrigatório. Especifique o seguinte:

      • isAdmin (booleano): obrigatório. Especifique se os membros do grupo de usuários devem ser administradores desta coleção.

      • canAddAssets (booleano): obrigatório. Especifique se os membros do grupo de usuários podem adicionar ativos à coleção.

      • canRemoveAssets (booleano): obrigatório. Especifique se os membros do grupo de usuários podem remover ativos da coleção.

      • canUpdateAssets (booleano): obrigatório. Especifique se os membros do grupo de usuários podem atualizar ativos na coleção.

      • canAddUsers (booleano): obrigatório. Especifique se os membros do grupo de usuários podem adicionar outros usuários à coleção.

      • canRemoveUsers (booleano): obrigatório. Especifique se os membros do grupo de usuários podem remover usuários da coleção.

Para obter mais informações sobre funções e permissões, visite a página Funções e permissões de usuário . Quando nenhuma função está selecionada, o padrão é a função padrão, conforme especificado por um administrador do Server na interface de administrador .

Exemplo de solicitação: cURL

curl --location --request PUT 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61db38834tssrdrs4cc65144387d4508/permissions' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'isAdmin=true' \ --data-urlencode 'canAddAssets=true' \ --data-urlencode 'canRemoveAssets=false' \ --data-urlencode 'canUpdateAssets=true' \ --data-urlencode 'canAddUsers=true' \ --data-urlencode 'canRemoveUsers=true'

Remover um usuário de uma coleção

Para remover um usuário de uma coleção existente, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId}/users/{userId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • userId (cadeia de caracteres): obrigatório. Insira o ID do usuário que deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/users/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Remover um fluxo de trabalho de uma coleção

Para remover um fluxo de trabalho de uma coleção existente, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId}/workflows/{appId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • appId (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/workflows/61db388fc565144387d45086' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Remover um insight de uma coleção

Para remover um insight de uma coleção existente, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId}/insights/{insightId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • insightId (cadeia de caracteres): obrigatório. Insira o ID do Insight que deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/insights/61db388fc565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Remover um agendamento de uma coleção

Para remover um agendamento de uma coleção existente, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId}/schedules/{scheduleId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • scheduleId (cadeia de caracteres): obrigatório. Insira o ID do agendamento que deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/schedules/61db3777c565144387d450867' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Remover um grupo de usuários de uma coleção

Para remover um grupo de usuários de uma coleção existente, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId}/userGroups/{userGroupId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários que você deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/a374ce806fd4488a8a5f07da1005334c/userGroups/61dc063d9938fe43b5e8fc80' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Excluir uma coleção

Para excluir uma coleção, use o ponto de extremidade DELETE {baseURL}/v3/collections/{collectionId} .

Nota

Somente administradores podem usar esse ponto de extremidade de API.

Parâmetros

  • collectionId (cadeia de caracteres): obrigatório. Insira o ID da coleção para especificar a coleção que deseja atualizar.

  • forceDelete (booleano): opcional. Selecione se deseja forçar a exclusão de uma coleção caso essa coleção tenha links para outros objetos, como usuários, grupos, fluxos de trabalho, insights e agendamentos. Se desejar que a coleção seja excluída e todos os links sejam apagados, defina o parâmetro forceDelete como "true" (verdadeiro). Quando não selecionado, o valor padrão é "false" (falso). Esse parâmetro é usado para proteger contra uma chamada errada.

Exemplo de solicitação: cURL

curl --location --request DELETE 'http://localhost/webapi/v3/collections/253fcf0b10204dc085f07bdf1b40e759?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relações de objetos

Se estiver criando uma coleção, você poderá usar objetos criados da seguinte maneira:

Objeto criado: " id " (por exemplo, "id": "7917969784f84bd09442f66996ecb8f3")

Você pode usá-lo como:

Exemplos de solicitações Postman

POST /v3/collections

Use POST /v3/collections endpoint.

GET /v3/collections/

Use GET /v3/collections endpoint.

PUT /v3/collections/{collectionId}

Use PUT /v3/collections/{collectionId} endpoint.

Para saber mais sobre solicitações Postman, visite a página de ajuda Como usar Postman .