Postman · Arazzo Workflow

Postman Tag a Collection for Governance

Version 1.0.0

Create a collection, apply governance tags to it, and read the tags back.

1 workflow 2 source APIs 1 provider
View Spec View on GitHub AI Agent BuilderAI AgentsAPI CatalogAPI ClientAPI DesignAPI DevelopmentAPI DocumentationAPI GovernanceAPI LifecycleAPI MonitoringAPI NetworkAPI PlatformAPI TestingAudit LogsAutomationCI/CDCollaborationCollectionsComplianceDiscoveryEnvironmentsFlowsGraphQLgRPCHTTPInsightsMCPMCP GeneratorMock ServersMockingMonitorsNewmanOpenAPIPlatformPrivate API NetworkPublic API NetworkSecret ScanningSpec HubSpecificationsSSOTestingVaultWebSocketWorkflowsWorkspacesArazzoWorkflows

Provider

postman

Workflows

tag-collection
Create a collection and govern it with tags.
Creates a collection, replaces its tag set with the supplied governance tags, and reads the tags back to confirm.
3 steps inputs: collectionName, tags, workspace outputs: collectionId, tags
1
createCollection
createCollection
Create the collection that will be tagged.
2
setTags
updateEntityTags
Replace the collection's tags with the supplied governance tags.
3
getTags
getEntityTags
Read the collection's tags back to confirm the governance labels.

Source API Descriptions

Arazzo Workflow Specification

postman-tag-collection-workflow.yml Raw ↑
arazzo: 1.0.1
info:
  title: Postman Tag a Collection for Governance
  summary: Create a collection, apply governance tags to it, and read the tags back.
  description: >-
    Tags drive governance by labeling assets with domain, lifecycle, or
    compliance metadata. This workflow creates a collection, applies a set of
    tags to it, and reads the tags back to confirm them. Each step spells out
    its request inline so the flow can be read and executed without opening the
    underlying OpenAPI descriptions.
  version: 1.0.0
sourceDescriptions:
- name: collectionsApi
  url: ../openapi/postman-collections-api-openapi.yml
  type: openapi
- name: tagsApi
  url: ../openapi/postman-tags-api-openapi.yml
  type: openapi
workflows:
- workflowId: tag-collection
  summary: Create a collection and govern it with tags.
  description: >-
    Creates a collection, replaces its tag set with the supplied governance
    tags, and reads the tags back to confirm.
  inputs:
    type: object
    required:
    - collectionName
    - tags
    properties:
      collectionName:
        type: string
        description: The name of the collection to create and tag.
      tags:
        type: array
        description: The tags to apply, each an object with a lowercase hyphenated slug.
        items:
          type: object
      workspace:
        type: string
        description: Optional workspace ID to create the collection in.
  steps:
  - stepId: createCollection
    description: >-
      Create the collection that will be tagged.
    operationId: createCollection
    parameters:
    - name: workspace
      in: query
      value: $inputs.workspace
    requestBody:
      contentType: application/json
      payload:
        collection:
          info:
            name: $inputs.collectionName
            schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      collectionId: $response.body#/collection/id
  - stepId: setTags
    description: >-
      Replace the collection's tags with the supplied governance tags.
    operationId: updateEntityTags
    parameters:
    - name: entityType
      in: path
      value: collections
    - name: entityId
      in: path
      value: $steps.createCollection.outputs.collectionId
    requestBody:
      contentType: application/json
      payload:
        tags: $inputs.tags
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      appliedTags: $response.body#/tags
  - stepId: getTags
    description: >-
      Read the collection's tags back to confirm the governance labels.
    operationId: getEntityTags
    parameters:
    - name: entityType
      in: path
      value: collections
    - name: entityId
      in: path
      value: $steps.createCollection.outputs.collectionId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      tags: $response.body#/tags
  outputs:
    collectionId: $steps.createCollection.outputs.collectionId
    tags: $steps.getTags.outputs.tags