/ home / kembitnl / kembitnl.topdesk / 1.0.2 / lookup / branch

kembitnl.topdesk.branch (1.0.2) — lookup

Looks up a branch ID based on a name

Authors: unknown

Install collection

Install with ansible-galaxy collection install kembitnl.topdesk:==1.0.2

Add to requirements.yml

  collections:
    - name: kembitnl.topdesk
      version: 1.0.2

Description

Performs a branch lookup in Topdesk.

The Topdesk environment variables should be set, see the README.

Inputs

    
column:
    default: id
    description: Optional name of the column to return. When omitted, the ID of the topdesk
      branch is returned.
    required: false
    type: str

archived:
    default: false
    description: Whether to search for archived or non-archived branches. Default only
      non-archived branches are returned.
    required: false
    type: bool

branchName:
    default: None
    description: Name of the branch in Topdesk.
    required: false
    type: str

headBranchId:
    default: None
    description: ID of the head branch to search for.
    required: false
    type: str

Outputs

Requested column name:
  description: Comma separated string with the branch IDs (or an array in case of
    a query instead of a lookup)
  returned: on success
  sample: CskezwOMYDhzdnjRGKDLVFPQBTH
  type: str