Skip to main content

Pontos de extremidade de coleções

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

Criar uma 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 usuário ou um grupo a uma coleção

Recuperar um registro de coleção

Recuperar Registros de Todas as Coleções

Atualizar um fluxo de trabalho 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 usuário ou grupo 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 coleção

Para carregar um novo fluxo de trabalho, use o ponto de extremidade POST {baseURL}/v3/workflows.

Parâmetros

  • Contrato (corpo): Para criar uma coleção, o parâmetro contrato é necessá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: BearerTokenGoesHere' --data-urlencode 'name'

Adicionar um usuário a uma coleção

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

082A8515AB7ADDAAD5B04255CF2AE567.png

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de coleção para especificar a coleção à qual pretende adicionar um utilizador.

  • updateWorkflowContract (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:

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

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

    • ColeçõesPermissões (corpo):

      • isPublic (booleano): obrigatório. Especifique se o usuário deve ser admin para esta coleção.

      • CanAddAssets ( boolean): Obrigatório. Especifique se o usuário pode adicionar ativos à coleção.

      • CanUpdateAssets ( boolean): Necessário. Especifique se o usuário pode atualizar ativos na coleção.

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

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

      • force (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: BearerTokenGoesHere' --data-urlencode 'UserId' 61d80f8628c94328082' --data-2007 18 08

Adicionar um insight a uma coleção

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

Parâmetros

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

  • Contrato (corpo): Obrigatório. Introduza uma informação sobre o insight. Especifique o seguinte:

    • name (cadeia de caracteres): obrigatório. Especifique o ID insight que 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: BearerTokenGoesHere' --data-urlencode 'perspicaz 61d80f33452835728c94328082'

Adicionar um agendamento a uma coleção

Para adicionar uma agenda a uma coleção, use o {baseURL}endpoint POST /v3/collections/{collectionId}/schedules .

Parâmetros

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

  • Contrato (corpo): Obrigatório. Introduza uma informação sobre a agenda. Especifique o seguinte:

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

Exemplo de solicitação: cURL

Curl --localização --REQUEST post 'http://localhost/webapi//v3/collections/7917969784f84bd09442f66996ecb8f3/schedules' --header 'Content-Type: Application/x-www-form-urlencoded' --header 'Authorization: BearerTokenGoesHere' --data-urlencode 'cheduleId' 61d80f334528377728c94328082'

Adicionar um fluxo de trabalho a uma coleção

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

Parâmetros

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

  • Contrato (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 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: BearerTokenGoesHere' --data-urlencode 'workflowId 61d80f3342233728c9432'

Adicionar um usuário ou um grupo a uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de coleção para especificar a coleção à qual pretende adicionar um grupo de utilizadores.

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

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

    • limit (cadeia de caracteres): opcional. Especifique a data de expiração para que o grupo de usuários faça parte desta coleção. Insira a data e a hora após a qual o fluxo de trabalho foi criado.

    • ColeçõesPermissões ( corpo): Obrigatório.

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

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

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

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

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

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

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: BearerTokenGoesHere' --data-urlencode 'userGroupId 61d83e2ef778247f14e8e6b6'

Recuperar um registro de coleção

Para obter informações sobre um fluxo de trabalho específico, use o ponto de extremidade GET {baseURL}/v3/workflows/{collectionId}.

Parâmetros

  • workflowCredentialType (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/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Recuperar Registros de Todas as Coleções

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

Parâmetros

  • view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode selecionar 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/workflows' \ --header 'Authorization: Bearer token-bearer-aqui'

Atualizar um fluxo de trabalho existente

Para alterar o nome ou o proprietário de uma coleção, use o {baseURL}endpoint PUT /v3/collections/{collectionId} .

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

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

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

    • ownerId (cadeia de caracteres): obrigatório. Insira o ID do 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: BearerTokenGoesHere' --data-urlencode 'name'

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

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza um ID de utilizador para o qual pretende alterar as permissões.

  • updateWorkflowContract (corpo): obrigatório. Introduza a ID de utilizador para a qual pretende alterar as permissões. Especifique o seguinte:

    • Data de validade (data): Obrigatório. Especifique a data de expiração de um usuário.

    • ColeçõesPermissões ( corpo): Obrigatório. Insira o ID do proprietário. Especifique o seguinte:

      • isPublic (booleano): obrigatório. Especifique se o usuário deve ser admin para esta coleção.

      • CanAddAssets ( boolean): Obrigatório. Especifique se o usuário pode adicionar ativos à coleção.

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

      • CanUpdateAssets ( boolean): Necessário. Especifique se o usuário pode atualizar ativos na coleção.

      • CanAddUsers ( boolean): Obrigatório. Especifique se o usuário pode adicionar outros usuários à coleção.

      • isPublic (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: BearerTokenGoesHere' --data-urlencode 'isAdmin

Atualizar permissões do Grupo de Usuários de uma Coleção

Para atualizar permissões de grupo de usuários para uma determinada coleção, use o {baseURL}endpoint PUT /v3/collections{collectionId}/{userGroupId}/Usergroups/ /permissions .

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de grupo de utilizadores para a qual pretende alterar as permissões.

  • updateWorkflowContract (corpo): obrigatório. Introduza o ID do grupo de utilizadores para o qual pretende alterar as permissões. Especifique o seguinte:

    • ExpirationDate ( data): Opcional. Especifique a data de expiração para um grupo de usuários.

    • ColeçõesPermissões ( corpo): Obrigatório. Especifique o seguinte:

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

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

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

      • CanUpdateAssets ( boolean): Necessário. Especifique se os membros do grupo de usuários podem atualizar ativos na coleção.

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

      • makePublished (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: BearerTokenGoesHere' --data-urlencode 'isAdmin

Remover um usuário de uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de utilizador que pretende remover da coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Remover um fluxo de trabalho de uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira um ID fluxo de trabalho que você deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Remover um insight de uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID insight que pretende remover da coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Remover um agendamento de uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira um ID de agendamento que você deseja remover da coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Remover um usuário ou grupo de uma coleção

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

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Introduza uma ID de grupo de utilizadores que pretende remover da coleção.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Excluir uma coleção

Para excluir um fluxo de trabalho específico, use o ponto de extremidade DELETE {baseURL}/v3/workflows/{collectionId}.

Parâmetros

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira o ID do fluxo de trabalho que deseja atualizar.

  • hasPrivateDataExemption (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 agendas. Se você quiser que a coleção seja excluída e todos os links sejam limpos, defina o parâmetro forceDelete como true. Quando não selecionado, o valor padrão é "false". Este parâmetro é usado para proteger contra uma chamada errante.

Exemplo de solicitação: cURL

curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer token-bearer-aqui'

Relações de objetos

Se você estiver carregando um fluxo de trabalho, você pode usar objetos criados da seguinte maneira:

Objeto criado: "workflowId" (for example, "id": "7917969784f84bd09442f66996ecb8f3")

Você pode usá-lo como:

Exemplos de solicitações Postman

POST /v3/collections

Use POST /v3/collections endpoint.

Obter /v3/collections/

Use GET /v3/collections endpoint.

COLOQUE /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.