openapi: 3.2.0
info:
  description: Credo AI server API
  title: Credo AI server Entity Section Assignments API
servers:
- url: /api/v2/credoai
tags:
- name: entity_section_assignments
paths:
  /entities/{entity_id}/section_assignments:
    post:
      description: Creates tasks for multiple questionnaire sections and assigns them to users or teams
      operationId: CredoAIWeb.API.V2.Entity.SectionsAssignmentController.create
      parameters:
      - description: The unique ID of the entity
        in: path
        name: entity_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TasksResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - entity_section_assignments
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/EntitySectionsAssignmentRequest'
        description: The task assignment details
components:
  schemas:
    TasksResponse:
      description: A collection of [TaskResource](#taskresource)
      properties:
        data:
          description: Content with [TaskResource](#taskresource) objects
          items:
            $ref: '#/components/schemas/TaskResource'
          type: array
      required:
      - data
      type: object
    TaskResource:
      description: ''
      properties:
        attributes:
          properties:
            assigner_id:
              description: ''
              type: string
            completed_at:
              description: ''
              type: string
            due_date:
              description: ''
              type: string
            entity_questionnaire_section_id:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            status:
              description: ''
              type: string
            sub_status:
              description: ''
              type: string
            team_ids:
              description: ''
              type: string
            timezone:
              description: ''
              type: string
            type:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            use_case_control_id:
              description: ''
              type: string
            use_case_id:
              description: ''
              type: string
            use_case_review_id:
              description: ''
              type: string
            user_ids:
              description: ''
              type: string
            vendor_id:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            assigner:
              properties:
                data:
                  properties:
                    id:
                      description: Related assigner resource id
                      type: string
                    type:
                      description: Type of related assigner resource
                      type: string
                  type: object
              type: object
            entity_questionnaire_section:
              properties:
                data:
                  properties:
                    id:
                      description: Related entity_questionnaire_section resource id
                      type: string
                    type:
                      description: Type of related entity_questionnaire_section resource
                      type: string
                  type: object
              type: object
            model:
              properties:
                data:
                  properties:
                    id:
                      description: Related model resource id
                      type: string
                    type:
                      description: Type of related model resource
                      type: string
                  type: object
              type: object
            teams:
              properties:
                data:
                  properties:
                    id:
                      description: Related teams resource id
                      type: string
                    type:
                      description: Type of related teams resource
                      type: string
                  type: object
              type: object
            use_case:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case resource id
                      type: string
                    type:
                      description: Type of related use_case resource
                      type: string
                  type: object
              type: object
            use_case_control:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_control resource id
                      type: string
                    type:
                      description: Type of related use_case_control resource
                      type: string
                  type: object
              type: object
            use_case_review:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_review resource id
                      type: string
                    type:
                      description: Type of related use_case_review resource
                      type: string
                  type: object
              type: object
            users:
              properties:
                data:
                  properties:
                    id:
                      description: Related users resource id
                      type: string
                    type:
                      description: Type of related users resource
                      type: string
                  type: object
              type: object
            vendor:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendor resource id
                      type: string
                    type:
                      description: Type of related vendor resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: tasks
          type: string
      type: object
    EntitySectionsAssignmentRequest:
      description: A JSON-API document with a single [EntitySectionsAssignmentResource](#entitysectionsassignmentresource) resource
      properties:
        data:
          $ref: '#/components/schemas/EntitySectionsAssignmentResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    EntitySectionsAssignmentResource:
      description: ''
      properties:
        attributes:
          properties:
            section_ids:
              description: string
              type: string
            team_id:
              description: ''
              type: string
            user_id:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties: {}
          type: object
        type:
          description: The JSON-API resource type
          example: section_assignments
          type: string
      type: object
    ForbiddenError:
      properties:
        errors:
          description: Errors
          items:
            properties:
              code:
                description: an application-specific error code, expressed as a string value.
                type: integer
              detail:
                description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
                type: string
              title:
                description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                type: string
            type: object
          type: array
      type: object
    AuthError:
      properties:
        errors:
          description: Errors
          items:
            properties:
              code:
                description: an application-specific error code, expressed as a string value.
                type: integer
              detail:
                description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
                type: string
              title:
                description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                type: string
            type: object
          type: array
      type: object
  securitySchemes:
    Bearer:
      in: header
      name: Authorization
      type: apiKey