Criar força de trabalhoIntegração

Namespace: microsoft.graph

Crie um novo objeto workforceIntegration .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) WorkforceIntegration.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application WorkforceIntegration.ReadWrite.All Indisponível.

Observação: esta API oferece transporte a permissões de administrador. Os usuários com funções de administrador podem acessar grupos dos quais não são membros.

Solicitação HTTP

POST /teamwork/workforceIntegrations

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-type application/json. Obrigatório.
MS-APP-ACTS-AS (preterido) Uma ID de usuário (GUID). Necessário somente se o token de autorização for um token de aplicativo; caso contrário, opcional. O MS-APP-ACTS-AS cabeçalho foi preterido e não é mais necessário com tokens de aplicativo.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto workforceIntegration .

A tabela a seguir lista as propriedades que você pode usar ao criar um objeto workforceIntegration .

Propriedade Tipo Descrição
apiVersion Int32 Versão da API para a URL de retorno de chamada. Comece com 1.
displayName Cadeia de caracteres Nome da integração da força de trabalho.
eligibilityFilteringEnabledEntities eligibilityFilteringEnabledEntities Suporte para exibir resultados filtrados por qualificação. Os valores possíveis são: none, swapRequest, offerShiftRequest, unknownFutureValue, timeOffReason. Use o cabeçalho da Prefer: include-unknown-enum-members solicitação para obter os seguintes membros nesta enumeração evolutiva: timeOffReason.
criptografia workforceIntegrationEncryption O recurso de criptografia de integração da força de trabalho.
isActive Booliano Indica se esta integração da força de trabalho está ativa e disponível no momento.
supportedEntities workforceIntegrationSupportedEntities As entidades Turnos com suporte para notificações de alteração síncronas. Os turnos chamam a URL fornecida quando ocorrem alterações de cliente nas entidades especificadas nesta propriedade. Por padrão, não há suporte para entidades para notificações de alteração. Os valores possíveis são: none, shift, swapRequest, userShiftPreferencestimeOffopenShiftopenShiftRequesttimeOffReasonofferShiftRequestunknownFutureValuetimeCard. timeOffRequest Use o cabeçalho da Prefer: include-unknown-enum-members solicitação para obter os seguintes valores nesta enumeração evolutiva: timeCard, timeOffReason , timeOff , timeOffRequest.
url Cadeia de caracteres URL de integração da força de trabalho usada para retornos de chamada do serviço Turnos.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um novo objeto workforceIntegration no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations
Content-Type: application/json

{
  "displayName": "ABCWorkforceIntegration",
  "apiVersion": 1,
  "isActive": true,
  "encryption": {
    "protocol": "sharedSecret",
    "secret": "My Secret"
  },
  "url": "https://ABCWorkforceIntegration.com/Contoso/",
  "supportedEntities": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "c5d0c76b-80c4-481c-be50-923cd8d680a1",
  "displayName": "ABCWorkforceIntegration",
  "apiVersion": 1,
  "isActive": true,
  "encryption": {
    "protocol": "sharedSecret",
    "secret": null
  },
  "url": "https://abcWorkforceIntegration.com/Contoso/",
  "supportedEntities": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

Exemplos de casos de uso da entidade WorkforceIntegration para filtragem de elegibilidade por regras do sistema de gerenciamento de força de trabalho (WFM)

Caso de uso: Criar um novo WorkforceIntegration com SwapRequest habilitado para filtragem de qualificação

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/teamwork/workforceIntegrations/
Authorization: Bearer {token}
Content-type: application/json

{
  "displayName": "ABCWorkforceIntegration",
  "apiVersion": 1,
  "isActive": true,
  "encryption": {
    "protocol": "sharedSecret",
    "secret": "My Secret"
  },
  "url": "https://ABCWorkforceIntegration.com/Contoso/",
  "supportedEntities": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 200 OK
{
  "id": "c5d0c76b-80c4-481c-be50-923cd8d680a1",
  "displayName": "ABCWorkforceIntegration",
  "apiVersion": 1,
  "isActive": true,
  "encryption": {
    "protocol": "sharedSecret",
    "secret": null
  },
  "url": "https://abcWorkforceIntegration.com/Contoso/",
  "supportedEntities": "Shift,SwapRequest",
  "eligibilityFilteringEnabledEntities": "SwapRequest"
}

Para ver como atualizar uma força de trabalho existenteIntegration com SwapRequest habilitado para filtragem de qualificação, consulte Atualizar.

Exemplo de busca de turnos qualificados quando SwapRequest está incluído em eligibilityFilteringEnabledEntities

A interação entre o aplicativo Turnos e os pontos de extremidade de integração da força de trabalho segue o padrão existente.

Solicitação

Este exemplo mostra uma solicitação feita pelo Shifts ao ponto de extremidade de integração da força de trabalho para buscar turnos qualificados para uma solicitação de troca.

POST https://abcWorkforceIntegration.com/Contoso/{apiVersion}/team/{teamId}/read
Accept-Language: en-us
{
  "requests": [
  {
     "id": "{shiftId}",
     "method": "GET”,
     "url": “/shifts/{shiftId}/requestableShifts?requestType={requestType}&startDateTime={startDateTime}&endDateTime={endDateTime}”
   }]
}

Resposta

O exemplo a seguir mostra a resposta do serviço de integração da força de trabalho.

HTTP/1.1 200 OK
{
  "responses": [
    "id": "{shiftId}",
    "status: 200,
    "body": {
       "data": [{shiftId}, {shiftId}...]
       "error": null
    }
  ]
}