Microsoft Office 365 · Arazzo Workflow

Microsoft Office 365 Update Group and Verify

Version 1.0.0

Patch a group's properties, then read it back to verify the change.

1 workflow 1 source API 1 provider
View Spec View on GitHub CloudCollaborationEnterpriseMicrosoftProductivityArazzoWorkflows

Provider

microsoft-office-365

Workflows

update-group-and-verify
Update a group's properties and confirm via a read-back.
Patches a group via PATCH /groups/{group-id} (204 no content), then reads the group via GET /groups/{group-id} (200) to verify the new property values.
2 steps inputs: description, displayName, groupId, visibility outputs: displayName, groupId
1
updateGroup
updateGroup
Patch the group with the supplied display name, description, and visibility. Only the provided properties change.
2
verifyGroup
getGroup
Read the group back by id to confirm the updated properties were persisted.

Source API Descriptions

Arazzo Workflow Specification

microsoft-office-365-update-group-and-verify-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Microsoft Office 365 Update Group and Verify
  summary: Patch a group's properties, then read it back to verify the change.
  description: >-
    Maintains an existing group's metadata. The workflow patches a group's
    display name, description, and visibility, then reads the group back by id to
    confirm the changes persisted. Because the update returns 204 with no body,
    the subsequent read is the only way to observe the new state. Every step
    spells out its request inline so the flow can be read and executed without
    opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: graphApi
  url: ../openapi/microsoft-graph-api-openapi.yml
  type: openapi
workflows:
- workflowId: update-group-and-verify
  summary: Update a group's properties and confirm via a read-back.
  description: >-
    Patches a group via PATCH /groups/{group-id} (204 no content), then reads
    the group via GET /groups/{group-id} (200) to verify the new property values.
  inputs:
    type: object
    required:
    - groupId
    - displayName
    properties:
      groupId:
        type: string
        description: The id of the group to update.
      displayName:
        type: string
        description: The new display name for the group.
      description:
        type: string
        description: The new description for the group.
      visibility:
        type: string
        description: The group visibility (Public or Private).
  steps:
  - stepId: updateGroup
    description: >-
      Patch the group with the supplied display name, description, and
      visibility. Only the provided properties change.
    operationId: updateGroup
    parameters:
    - name: group-id
      in: path
      value: $inputs.groupId
    requestBody:
      contentType: application/json
      payload:
        displayName: $inputs.displayName
        description: $inputs.description
        visibility: $inputs.visibility
    successCriteria:
    - condition: $statusCode == 204
    outputs:
      groupId: $inputs.groupId
  - stepId: verifyGroup
    description: >-
      Read the group back by id to confirm the updated properties were
      persisted.
    operationId: getGroup
    parameters:
    - name: group-id
      in: path
      value: $inputs.groupId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      groupId: $response.body#/id
      displayName: $response.body#/displayName
      description: $response.body#/description
  outputs:
    groupId: $steps.verifyGroup.outputs.groupId
    displayName: $steps.verifyGroup.outputs.displayName