Wegalvanize Robots Folders Collaborators API

openapi: 3.2.0
info:
  title: HighBond API Reference Robots Folders Collaborators API
  version: 1.1.0
  description: Welcome to the API documentation for HighBond.
  x-logo:
    url: ./assets/logo.png
    altText: HighBond Logo
servers:
- url: '{protocol}://{server}/v1'
  variables:
    protocol:
      default: https
    server:
      default: apis-us.highbond.com
      enum:
      - apis-us.highbond.com
      - apis-ca.highbond.com
      - apis-eu.highbond.com
      - apis-ap.highbond.com
      - apis-au.highbond.com
      - apis-af.highbond.com
      - apis-sa.highbond.com
      - apis-jp.highbond.com
security:
- bearerToken: []
tags:
- name: Robots Folders Collaborators
  x-displayName: Robots Folders Collaborators
  description: Folder's collaborators are users who have access to all the robots in that folder.
paths:
  /orgs/{org_id}/robots_folders/{folder_id}/collaborators:
    get:
      tags:
      - Robots Folders Collaborators
      operationId: listFolderCollaborators
      summary: List Folder Collaborators
      description: Get a list of collaborators from a folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      - $ref: '#/components/parameters/robotQueryOffsetParam'
      - $ref: '#/components/parameters/robotQueryUsersPerPageParam'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ListFolderCollaboratorsResponse'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      tags:
      - Robots Folders Collaborators
      operationId: createFolderCollaborator
      summary: Create Folder Collaborator
      description: Create a single collaborator for a folder.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      requestBody:
        description: The data required to create a robot.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderCollaboratorRequest'
      responses:
        '200':
          description: Success
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/FolderCollaboratorResponse'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          description: 'Unprocessable entity.

            '
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - status: 422
                  title: Unprocessable Entity
  /orgs/{org_id}/robots_folders/{folder_id}/collaborators/{user_id}:
    patch:
      tags:
      - Robots Folders Collaborators
      operationId: updateFolderCollaborator
      summary: Update folder collaborator
      description: Updates a folder collaborator.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      - $ref: '#/components/parameters/folderCollaboratorUserIdParam'
      requestBody:
        description: The data required to update a folder collaborator.
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/UpdateFolderCollaboratorRequest'
            example:
              data:
                attributes:
                  role: editor
      responses:
        '200':
          description: Collaborator resource updated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/FolderCollaboratorResponse'
              example:
                data:
                  id: 123
                  type: collaborators
                  attributes:
                    email: user@diligent.com
                    username: User
                    role: editor
                    admin: false
        '400':
          $ref: '#/components/responses/SchemaValidationFailed'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
    delete:
      tags:
      - Robots Folders Collaborators
      operationId: deleteFolderCollaborator
      summary: Delete folder collaborator
      description: Deletes a folder collaborator.
      parameters:
      - $ref: '#/components/parameters/orgIdParam'
      - $ref: '#/components/parameters/folderIdParam'
      - $ref: '#/components/parameters/folderCollaboratorUserIdParam'
      responses:
        '200':
          description: Collaborator resource deleted.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/FolderCollaboratorResponse'
              example:
                data:
                  id: 123
                  type: collaborators
                  attributes:
                    email: user@diligent.com
                    username: User
                    role: editor
                    admin: false
        '400':
          $ref: '#/components/responses/SchemaValidationFailed'
        '401':
          $ref: '#/components/responses/BadCredentials'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    SchemaValidationFailed:
      description: Bad Request
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - status: 400
              title: Bad Request
              code: bad_request
              detail: params.org_id should NOT be shorter than 1 characters
    Forbidden:
      description: Forbidden.
    BadCredentials:
      description: Bad credentials.
  schemas:
    UpdateFolderCollaboratorRequest:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          properties:
            attributes:
              type: object
              properties:
                role:
                  type: string
                  enum:
                  - reviewer
                  - editor
                  - owner
                  - readonly
                  - developer
                  description: The role a collaborator can have
    CreateFolderCollaboratorRequest:
      type: object
      description: The data associated with the resource.
      required:
      - data
      properties:
        data:
          type: object
          properties:
            attributes:
              type: object
              properties:
                user_id:
                  type: number
                  description: The user ID.
                  example: 1
                role:
                  type: string
                  enum:
                  - reviewer
                  - editor
                  - owner
                  - readonly
                  - developer
                  description: The role a collaborator can have
    Error:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          description: The HTTP status code.
        source:
          type: object
          description: Indicates which part of the request document caused the error.
          required:
          - pointer
          properties:
            pointer:
              type: string
              description: 'A JSON Pointer <a href="https://tools.ietf.org/html/rfc6901" target="_blank">(RFC6901)</a> to the associated entity

                in the request document.

                '
        code:
          type: string
          description: Application-specific error code, expressed as a string value.
        title:
          type: string
          description: A short, human-readable summary of the problem.
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
    FolderCollaboratorResponse:
      type: object
      description: The data associated with the resource.
      properties:
        data:
          type: object
          properties:
            id:
              type: number
              description: The user ID.
              example: 1
            type:
              type: string
              description: The classification of the object (`"collaborators"`).
              example: collaborators
            attributes:
              type: object
              description: The attributes associated with the resource.
              properties:
                username:
                  type: string
                  description: The username
                  example: user
                email:
                  type: string
                  description: The email of the user.
                  example: user@diligent.com
                role:
                  type: string
                  enum:
                  - reviewer
                  - editor
                  - owner
                  - readonly
                  - developer
                  description: The role a collaborator can have
                admin:
                  type: boolean
                  description: Whether is admin or not
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ListFolderCollaboratorsResponse:
      type: object
      description: The data associated with the resource.
      properties:
        data:
          type: array
          description: The data associated with the resource
          items:
            type: object
            properties:
              id:
                type: number
                description: The user ID.
                example: 1
              type:
                type: string
                description: The classification of the object (`"collaborators"`).
                example: collaborators
              attributes:
                type: object
                description: The attributes associated with the resource.
                properties:
                  username:
                    type: string
                    description: The username
                    example: user
                  email:
                    type: string
                    description: The email of the user.
                    example: user@diligent.com
                  role:
                    type: string
                    enum:
                    - reviewer
                    - editor
                    - owner
                    - readonly
                    - developer
                    description: The role a collaborator can have
                  admin:
                    type: boolean
                    description: Whether is admin or not
        total:
          type: number
          description: The total number of collaborators in the folder.
          example: 100
  parameters:
    robotQueryOffsetParam:
      name: offset
      in: query
      required: false
      description: Required data records start position, start from 0
      schema:
        type: integer
        minimum: 0
        example: 1
    robotQueryUsersPerPageParam:
      name: usersPerPage
      in: query
      required: false
      description: Required number of records to read, start from 1
      schema:
        type: integer
        minimum: 1
        example: 2
    folderCollaboratorUserIdParam:
      in: path
      name: user_id
      description: The ID of the user.
      required: true
      schema:
        type: number
        example: 2
    folderIdParam:
      in: path
      name: folder_id
      description: The ID of the folder.
      required: true
      schema:
        type: number
        example: 2
    orgIdParam:
      in: path
      name: org_id
      description: The ID of the HighBond instance.
      required: true
      schema:
        type: string
        example: 1
  securitySchemes:
    bearerToken:
      description: 'HighBond offers the industry-standard OAuth 2.0 flow for connecting to the HighBond platform. OAuth 2.0 provides a

        safe and secure way to access data, while protecting your account credentials.

        '
      type: http
      scheme: bearer
      bearerFormat: oauth2
x-tagGroups:
- name: Core resources
  tags:
  - Robots Agents
  - Robots
  - Robot Tasks
  - Robot Jobs
  - Robot Apps
  - Robot Script Versions
  - Robot Activations
  - Robot Files
  - Robot Working Files
  - Robot Collaborators
  - Robots Folders Collaborators
  - Robot Users
  - Robots Folders
  - Storyboards
  - Collections
  - Questionnaires
  - Analyses
  - Surveys
  - Event Reports
  - Tables
  - Table columns
  - Records
  - Record columns
  - Record statuses
  - Interpretations
  - Metrics
  - Workflow Groups
  - Results Users
  - Results Triggers
  - Project types
  - Custom attributes
  - Request item statuses
  - Projects
  - Projects Admin
  - Planning files
  - Results files
  - Objectives
  - Narratives
  - Risks
  - Controls
  - Control performance schedules
  - Mitigations
  - Control test plans
  - Control tests
  - Attachments
  - Walkthroughs
  - Issues
  - Actions
  - Collaborators
  - Request Items
  - To-dos
  - Sign-offs
  - Entities
  - Scheduler Filters
  - Frameworks
  - Handlers
  - Workflows in Asset Inventory/Asset Manager
  - Asset types
  - Asset record types
  - Attribute types
  - Assets
  - Asset Relationships
  - Asset records
  - Asset Record Relationships
  - Events
  - Template Toolkits
  - Toolkits
  - Roles
  - Role Deletion
  - Compliance Maps
  - Time entries
  - Non-project time categories
  - Timesheets
  - Importer
  - System Users
  - Organizations
  - Impact Reports
  - Activities
  - Users
  - Groups
  - Scheduled Users
  - Scheduled Projects
  - Scheduled Hours
  - Extract
  - Strategy