swagger.yaml

swagger: "2.0"
info:
  version: 1.0.0
  title: Challenge V6 API
  description: >
    ## Pagination

    - Requests that return multiple items will be paginated to 20 items by
    default.

    - You can specify further pages with the `page` parameter.

    - You can also set a custom page size up to 100 with the `perPage`
    parameter.

    - Pagination response data is included in http headers.

    - By default, the response header contains links with `next`, `last`,
    `first`, `prev` resource links.


    ## Access levels

    - M2M token is supported, all non-public-accessed endpoint can be accessed
    using M2M token with proper scopes.

    - Only admins and copilots can create/update an entity.

    - Copilots can **only** update entities they have created. (eg. copilot A
    cannot update a challenge created by copilot B)

    - Non-admin users can access challenges with groups only if they belong to
    any of the groups

    - It will be considered as admin user if using valid M2M token(having read
    challenge scope) to list challenges or retrieve challenge by id

    - Users can access attachments of a challenge only when the user can access the challenge itself.
host: api.topcoder.com
basePath: /v6
schemes:
  - http
  - https
securityDefinitions:
  bearer:
    type: apiKey
    name: Authorization
    in: header
paths:
  /challenges:
    get:
      tags:
        - Challenges
      description: |
        Retrieve challenges in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage"
        - name: id
          in: query
          description: Filter by id, exact match
          required: false
          type: string
          format: UUI
        - name: selfService
          in: query
          description: Filter by selfService flag
          required: false
          type: boolean
        - name: selfServiceCopilot
          in: query
          description: Filter by selfServiceCopilot
          required: false
          type: string
        - name: confidentialityType
          in: query
          description: Filter by confidentialityType
          required: false
          type: string
          enum: [public, private]
        - name: directProjectId
          in: query
          description: Filter by directProjectId
          required: false
          type: integer
        - name: typeIds
          in: query
          description: Filter by multiple type IDs, exact match.
          required: false
          type: array
          items:
            type: string
            format: UUID
        - name: trackIds
          in: query
          description: Filter by multiple track IDs, exact match.
          required: false
          type: array
          items:
            type: string
            format: UUID
        - name: types
          in: query
          description: Filter by multiple type abbreviation, exact match. If types is provided, typeIds will be ignored
          required: false
          type: array
          items:
            type: string
        - name: tracks
          in: query
          description: Filter by multiple track abbreviation, exact match. If tracks is provided, trackIds will be ignored
          required: false
          type: array
          items:
            type: string
        - name: typeId
          in: query
          description: Filter by type id, exact match. If type is provided, typeId will be ignored
          required: false
          type: string
          format: UUID
        - name: trackId
          in: query
          description: Filter by track id, exact match. If track is provided, trackId will be ignored
          required: false
          type: string
          format: UUID
        - name: type
          in: query
          description: Filter by type abbreviation, exact match. If provided, the typeId will be ignored
          required: false
          type: string
        - name: track
          in: query
          description: Filter by track, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: name
          in: query
          description: Filter by name, case-insensitive, partial matches are allowed. If search is provided, name will be ignored
          required: false
          type: string
        - name: search
          in: query
          description: Filter by name, description and tags fields, case-insensitive, partial matches are allowed. If search is provided, name and description will be ignored.
          required: false
          type: string
        - name: description
          in: query
          description: Filter by description, case-insensitive, partial matches are allowed. If search is provided, description will be ignored.
          required: false
          type: string
        - name: timelineTemplateId
          in: query
          description: Filter by timeline template id, exact match
          required: false
          type: string
        - name: reviewType
          in: query
          description: Filter by review type, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: tag
          in: query
          description: Filter by tag name, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: tags
          in: query
          description: Filter by multiple tag names, case-insensitive, partial matches are allowed.
          required: false
          type: array
          items:
            type: string
        - name: includeAllTags
          in: query
          description: Require all provided tags to be present on a challenge for a match.
          required: false
          default: true
          type: boolean
        - name: projectId
          in: query
          description: Filter by v5 project id, exact match.
          required: false
          type: integer
          minimum: 1
        - name: projectIds
          in: query
          description: Filter by multiple v5 project ids (array). Use repeated query params, e.g. projectIds[]=1&projectIds[]=2.
          required: false
          type: array
          items:
            type: integer
            minimum: 1
          collectionFormat: brackets
        - name: forumId
          in: query
          description: Filter by forum id, exact match.
          required: false
          type: integer
        - name: legacyId
          in: query
          description: Filter by legacy id, exact match.
          required: false
          type: integer
        - name: status
          in: query
          description: Filter by status, case-insensitive, exact match.
          required: false
          type: string
          enum:
            - NEW
            - DRAFT
            - CANCELLED
            - ACTIVE
            - COMPLETED
            - DELETED
            - CANCELLED_FAILED_REVIEW
            - CANCELLED_FAILED_SCREENING
            - CANCELLED_ZERO_SUBMISSIONS
            - CANCELLED_WINNER_UNRESPONSIVE
            - CANCELLED_CLIENT_REQUEST
            - CANCELLED_REQUIREMENTS_INFEASIBLE
            - CANCELLED_ZERO_REGISTRATIONS
        - name: group
          in: query
          description: Filter by group name, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: startDateStart
          in: query
          description: Filter by start date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: startDateEnd
          in: query
          description: Filter by start date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: endDateStart
          in: query
          description: Filter by end date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: endDateEnd
          in: query
          description: Filter by end date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: currentPhaseName
          in: query
          description: Filter by name of the current phase
          required: false
          type: string
        - name: createdDateStart
          in: query
          description: Filter by created date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: createdDateEnd
          in: query
          description: Filter by created date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: updatedDateStart
          in: query
          description: Filter by updated date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: updatedDateEnd
          in: query
          description: Filter by updated date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: registrationStartDateStart
          in: query
          description: Filter by registration start date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: registrationStartDateEnd
          in: query
          description: Filter by registration start date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: registrationEndDateStart
          in: query
          description: Filter by registration end date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: registrationEndDateEnd
          in: query
          description: Filter by registration end date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: submissionStartDateStart
          in: query
          description: Filter by submission start date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: submissionStartDateEnd
          in: query
          description: Filter by submission start date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: submissionEndDateStart
          in: query
          description: Filter by submission end date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: submissionEndDateEnd
          in: query
          description: Filter by submission end date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: createdBy
          in: query
          description: Filter by 'createdBy' field, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: updatedBy
          in: query
          description: Filter by 'updatedBy' field, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: isLightweight
          in: query
          description: Turn off description and privateDescription for a smaller response payload
          required: false
          type: boolean
          default: false
        - name: memberId
          in: query
          description: Filter challenges memberId has access to
          required: false
          type: string
        - name: sortBy
          in: query
          description: Sort the results by the field.
          required: false
          type: string
          enum:
            [
              updatedBy,
              updated,
              createdBy,
              created,
              endDate,
              startDate,
              projectId,
              name,
              typeId,
              numOfRegistrants,
              numOfSubmissions,
              status,
              overview.totalPrizes,
            ]
        - name: sortOrder
          in: query
          description: Order the results by the asc/desc.
          required: false
          type: string
          enum: [asc, desc]
        - name: isTask
          in: query
          description: Filter based on the task.isTask property. Only available for admins/m2m. Will be ignored for regular users or not authenticated users
          required: false
          type: boolean
        - name: taskIsAssigned
          in: query
          description: Filter based on the task.isAssigned property. Only available for admins/m2m. Will be ignored for regular users or not authenticated users
          required: false
          type: boolean
        - name: taskMemberId
          in: query
          description: Filter based on the task.memberId property. Only available for admins/m2m. Will be ignored for regular users or not authenticated users
          required: false
          type: string
        - name: events
          in: query
          description: Filter by multiple event keys (tco21)
          required: false
          type: array
          items:
            type: string
        - name: tco
          in: query
          description: Filter by tco eligible events
          required: false
          type: boolean
        - name: includeAllEvents
          in: query
          description: Require all provided events to be present on a challenge for a match
          required: false
          default: true
          type: boolean
        - name: useSchedulingAPI
          in: query
          description: Search based on `legacy.useSchedulingAPI`
          type: boolean
          required: false
        - name: totalPrizesFrom
          in: query
          description: Filter by the lowest amount of total prizes on the challenge
          type: number
          required: false
          minimum: 0
        - name: totalPrizesTo
          in: query
          description: Filter by the highest amount of total prizes on the challenge
          type: number
          required: false
          minimum: 0
        - in: body
          name: body
          required: false
          schema:
            $ref: "#/definitions/SearchChallengeRequestBody"
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/Challenge"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - Challenges
      description: Create a new challenge in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeRequestBodyForCreate"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the challenge
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Not found. Timeline Template is not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenges/{challengeId}:
    get:
      tags:
        - Challenges
      description: Retrieve the Challenge with provided challenge id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to wiew the challenge
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - Challenges
      description: Update the challenge with the provided id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeRequestBodyForFullyUpdate"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - Challenges
      description: Partially update the challenge with the provided id. Only the fields that are provided in the body will be changed.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeRequestBodyForPartiallyUpdate"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - Challenges
      description: Delete the challenge with the provided id.
        Only challenges with status of "NEW" can be deleted.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge to delete
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenges/{challengeId}/close-marathon-match:
    post:
      tags:
        - Challenges
      description: >
        Close a Marathon Match challenge by selecting winners from final review
        summations, closing all phases, and setting the challenge status to
        COMPLETED.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/app-version"
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of the Marathon Match challenge to close
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/Challenge"
        "400":
          description: Bad request. The challenge is not a Marathon Match or required data is missing.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. Only admins or M2M tokens with update scope can close the challenge.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-types:
    get:
      tags:
        - ChallengeTypes
      description: Retrieve challenge types in the system.
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage100"
        - name: name
          in: query
          description: Filter by name, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: description
          in: query
          description: Filter by description. Partial matches are allowed.
          required: false
          type: string
        - name: isActive
          in: query
          description: Filter by isActive flag.
          required: false
          type: boolean
        - name: isTask
          in: query
          description: Filter by isTask flag.
          required: false
          type: boolean
          default: false
        - name: abbreviation
          in: query
          description: Filter by abbreviation. Partial matches are allowed.
          required: false
          type: string
        - name: legacyId
          in: query
          description: Filter by numeric legacy id.
          required: false
          type: integer
        - name: isLegacy
          in: query
          description: Filter by legacy visibility flag. Defaults to false when omitted.
          required: false
          type: boolean
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/ChallengeType"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request.  Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - ChallengeTypes
      description: Create a new challenge type in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTypeData"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeType"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the challenge type
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge type has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-types/{challengeTypeId}:
    get:
      tags:
        - ChallengeTypes
      description: Retrieve the Challenge Type with provided challenge type id.
      produces:
        - application/json
      parameters:
        - name: challengeTypeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge type to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/ChallengeType"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge type not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - ChallengeTypes
      description: Update the challenge type with the specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTypeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeType to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTypeData"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeType"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge type
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge type not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge type has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - ChallengeTypes
      description: Partially update the challenge type with specified id. Only the fields that are provided will be updated.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTypeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeType to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTypeDataPatch"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeType"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge type
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge type not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge type has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - ChallengeTypes
      description: Delete the challenge type with specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTypeId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeType to be deleted
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeType"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to delete the challenge type.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Not Found. Challenge type not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-tracks:
    get:
      tags:
        - ChallengeTracks
      description: Retrieve challenge tracks in the system.
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage100"
        - name: name
          in: query
          description: Filter by name, case-insensitive, partial matches are allowed.
          required: false
          type: string
        - name: description
          in: query
          description: Filter by description. Partial matches are allowed.
          required: false
          type: string
        - name: isActive
          in: query
          description: Filter by isActive flag.
          required: false
          type: boolean
        - name: abbreviation
          in: query
          description: Filter by abbreviation. Partial matches are allowed.
          required: false
          type: string
        - name: legacyId
          in: query
          description: Filter by numeric legacy id.
          required: false
          type: integer
        - name: track
          in: query
          description: Filter by canonical track enum.
          required: false
          type: string
        - name: isLegacy
          in: query
          description: Filter by legacy visibility flag. Defaults to false when omitted.
          required: false
          type: boolean
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/ChallengeTrack"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - ChallengeTracks
      description: Create a new challenge track in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTrackData"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTrack"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the challenge track
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge track has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-tracks/{challengeTrackId}:
    get:
      tags:
        - ChallengeTracks
      description: Retrieve the Challenge Track with provided challenge track id.
      produces:
        - application/json
      parameters:
        - name: challengeTrackId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge track to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/ChallengeTrack"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge track not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - ChallengeTracks
      description: Update the challenge track with the specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTrackId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeTrack to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTrackData"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTrack"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge track
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge track not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge track has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - ChallengeTracks
      description: Partially update the challenge track with specified id. Only the fields that are provided will be updated.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTrackId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeTrack to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTrackDataPatch"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTrack"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge track
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge track not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge track has already used the same name or abbreviation.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - ChallengeTracks
      description: Delete the challenge track with specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTrackId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challengeTrack to be deleted.
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTrack"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to delete the challenge track.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Not Found. Challenge track not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-phases:
    get:
      tags:
        - ChallengePhases
      description: Retrieve challenge phases in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage100"
        - name: name
          in: query
          description: Filter by name, case-insensitive, partial matches are allowed.
          required: false
          type: string
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/Phase"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - ChallengePhases
      description: Create a new challenge phase in the system. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/PhaseData"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Phase"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden.  The requester does not have the correct permission to create the challenge phase
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge phase has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-phases/{challengePhaseId}:
    get:
      tags:
        - ChallengePhases
      description: Retrieve the Challenge phase with provided challenge phase id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengePhaseId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge phase to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/Phase"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to access the challenge phase
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge phase not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - ChallengePhases
      description: Update the challenge phase with the specified id. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengePhaseId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge phase to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/PhaseData"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Phase"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge phase
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge phase not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge Phase has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - ChallengePhases
      description: Partially update the challenge phase with the provided id. Only the fields that are provided in the body will be changed. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengePhaseId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge phase to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/PhaseDataPatch"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Phase"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the challenge phase
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge phase not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other challenge Phase has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - ChallengePhases
      description: Delete the Challenge phase with provided challenge phase id. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengePhaseId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge phase to be deleted
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Phase"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden.  The requester does not have the correct permission to delete the challenge phase
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge phase not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /timeline-templates:
    get:
      tags:
        - TimelineTemplates
      description: Retrieve timeline templates in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage"
        - name: name
          in: query
          description: "Filter by name, case-insensitive, partial matches are allowed."
          required: false
          type: string
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/TimelineTemplate"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - TimelineTemplates
      description: Create a new timeline template in the system. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/TimelineTemplateData"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/TimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the timeline template
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other timeline template has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /timeline-templates/{timelineTemplateId}:
    get:
      tags:
        - TimelineTemplates
      description: Retrieve the timeline template with provided id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: timelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of timeline template to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/TimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to access the timeline template
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Timeline template not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - TimelineTemplates
      description: Update the timeline template with the specified id. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: timelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of timeline template to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/TimelineTemplateData"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/TimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the timeline template
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Timeline template not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other timeline template has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - TimelineTemplates
      description: Partially update the timeline template with the provided id. Only the fields that are provided in the body will be changed. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: timelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of timeline template to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/TimelineTemplateDataPatch"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/TimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the timeline template.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Timeline template not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. Other timeline template has already used the same name.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - TimelineTemplates
      description: Delete the timeline template with provided id. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: timelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of timeline template to be deleted
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/TimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to delete the timeline template.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Timeline template not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-timelines:
    get:
      tags:
        - ChallengeTimelineTemplates
      description: Retrieve challenge timeline templates in the system.
      produces:
        - application/json
      parameters:
        - name: typeId
          in: query
          description: Filter by challenge type id
          required: false
          type: string
          format: UUID
        - name: trackId
          in: query
          description: Filter by challenge track id
          required: false
          type: string
          format: UUID
        - name: timelineTemplateId
          in: query
          description: Filter by timeline template id
          required: false
          type: string
          format: UUID
        - name: isDefault
          in: query
          description: Filter by isDefault flag
          required: false
          type: boolean
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/ChallengeTimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    post:
      tags:
        - ChallengeTimelineTemplates
      description: Create a new challengetimeline template in the system.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplateData"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the timeline template
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Not Found. One of the parameter doesn't exist
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. The challenge timeline template is already defined.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-timelines/{challengeTimelineTemplateId}:
    get:
      tags:
        - ChallengeTimelineTemplates
      description: Retrieve the challenge timeline template with provided id.
      produces:
        - application/json
      parameters:
        - name: challengeTimelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge timeline template to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Entity not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - ChallengeTimelineTemplates
      description: Update the challenge timeline template with the specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTimelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge timeline template to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplateData"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden.  The requester does not have the correct permission to update the timeline template.
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Not Found. One of the parameter doesn't exist
          schema:
            $ref: "#/definitions/ErrorModel"
        "409":
          description: Conflict. The challenge timeline template is already defined.
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - ChallengeTimelineTemplates
      description: Delete the challenge timeline template with provided id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeTimelineTemplateId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of challenge timeline template to be deleted
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/ChallengeTimelineTemplate"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden.  The requester does not have the correct permission to delete the timeline template
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Timeline template not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenge-auditLogs:
    get:
      tags:
        - AuditLog
      description: Retrieve the auditLog for the specified filter parameters. Only admins can access this endpoint.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - $ref: "#/parameters/page"
        - $ref: "#/parameters/perPage"
        - name: challengeId
          in: query
          description: Filter by challengeId.
          required: false
          type: string
        - name: fieldName
          in: query
          description: Filter by fieldName. partial matches are allowed
          required: false
          type: string
        - name: createdDateStart
          in: query
          description: Filter by created date (lower bound of date range)
          required: false
          type: string
          format: date-time
        - name: createdDateEnd
          in: query
          description: Filter by created date (upper bound of date range)
          required: false
          type: string
          format: date-time
        - name: createdBy
          in: query
          description: Filter by createdBy field.
          required: false
          type: string
      responses:
        "200":
          description: OK
          schema:
            type: array
            items:
              $ref: "#/definitions/AuditLogEntry"
          headers:
            X-Next-Page:
              type: integer
              description: The index of the next page
            X-Page:
              type: integer
              description: The index of the current page (starting at 1)
            X-Per-Page:
              type: integer
              description: The number of items to list per page
            X-Prev-Page:
              type: integer
              description: The index of the previous page
            X-Total:
              type: integer
              description: The total number of items
            X-Total-Pages:
              type: integer
              description: The total number of pages
            Link:
              type: string
              description: Pagination link header.
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to access the audit log
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenges/{challengeId}/attachments:
    post:
      tags:
        - Attachments
      description: Create a new attachment in the system. If you want to create multiple attachment, you can pass an array of objects instead of a single object.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: the challenge id
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/CreateUpdateAttachmentRequestBody"
      responses:
        "201":
          description: Created - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Attachment"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to create the attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenges/{challengeId}/attachments/{attachmentId}:
    get:
      tags:
        - Attachments
      description: Retrieve the Attachment with provided attachment id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: the challenge id
        - name: attachmentId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of attachment to retrieve
      responses:
        "200":
          description: OK
          schema:
            $ref: "#/definitions/Attachment"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden.  The requester does not have the correct permission to access the attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Attachment not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    put:
      tags:
        - Attachments
      description: Update the attachment with the specified id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: the challenge id
        - name: attachmentId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of attachment to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/CreateUpdateAttachmentRequestBody"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Attachment"
        "400":
          description: Bad request.  Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Attachment not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    patch:
      tags:
        - Attachments
      description: Partially update the attachment with the provided id. Only the fields that are provided in the body will be changed.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: the challenge id
        - name: attachmentId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of attachment to update
        - in: body
          name: body
          required: true
          schema:
            $ref: "#/definitions/PartiallyUpdateAttachmentRequestBody"
      responses:
        "200":
          description: Updated - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Attachment"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to update the attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Attachment not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
    delete:
      tags:
        - Attachments
      description: Delete the Attachment with provided attachment id.
      security:
        - bearer: []
      produces:
        - application/json
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: the challenge id
        - name: attachmentId
          in: path
          required: true
          type: string
          format: UUID
          description: The id of attachment to be deleted
      responses:
        "200":
          description: Deleted - The request was successful and the resource is returned.
          schema:
            $ref: "#/definitions/Attachment"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to delete the attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Attachment not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /challenges/{challengeId}/attachments/{attachmentId}/download:
    get:
      tags:
        - Attachments
      description: Download attachment of challenge.
      security:
        - bearer: []
      produces:
        - application/octet-stream
      parameters:
        - name: challengeId
          in: path
          required: true
          type: string
          format: UUID
          description: The challenge id
        - name: attachmentId
          in: path
          required: true
          type: string
          format: UUID
          description: The attachment id
      responses:
        "200":
          description: "OK, attachment is downloaded"
        "400":
          description: Bad request. Request parameters were invalid.
          schema:
            $ref: "#/definitions/ErrorModel"
        "401":
          description: Unauthorized. Fail to authenticate the requester.
          schema:
            $ref: "#/definitions/ErrorModel"
        "403":
          description: Forbidden. The requester does not have the correct permission to download attachment
          schema:
            $ref: "#/definitions/ErrorModel"
        "404":
          description: Challenge not found
          schema:
            $ref: "#/definitions/ErrorModel"
        "500":
          description: Internal Server Error
          schema:
            $ref: "#/definitions/ErrorModel"
  /health:
    get:
      tags:
        - Health
      description: |
        Get health status of the app.
      produces:
        - application/json
      responses:
        "200":
          description: OK
          schema:
            type: object
            properties:
              checksRun:
                type: integer
            required:
              - checksRun
        "503":
          description: Service unavailable
          schema:
            $ref: "#/definitions/ErrorModel"
parameters:
  page:
    name: page
    in: query
    description: The page number.
    required: false
    type: integer
    minimum: 1
    default: 1
  perPage:
    name: perPage
    in: query
    description: The number of items to list per page.
    required: false
    type: integer
    minimum: 1
    default: 20
    maximum: 100
  perPage100:
    name: perPage
    in: query
    description: The number of items to list per page.
    required: false
    type: integer
    minimum: 1
    default: 100
    maximum: 100
  app-version:
    name: app-version
    in: header
    description: >
      The app version:

      - 1.1.0: With 1.1.0 or later version, challenge-api supports create/update challenge with "skills" data in request payload,
      and with "skills" data in response body when get/search/create/update challenges.

      - 2.0.0: With 2.0.0 or later version, challenge-api supports "payments" data in response body when get/search/create/update challenges for admin/m2m user.
    required: false
    type: string
    default: 1.0.0
definitions:
  Challenge:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The challenge id.
            format: UUID
      - $ref: "#/definitions/ChallengeData"
    required:
      - id
  ChallengeData:
    type: object
    properties:
      typeId:
        type: string
        format: UUID
      trackId:
        type: string
        format: UUID
      legacy:
        type: object
        properties:
          track:
            type: string
          subTrack:
            type: string
          reviewType:
            type: string
            enum:
              - "INTERNAL"
              - "COMMUNITY"
            default: "INTERNAL"
          confidentialityType:
            type: string
            default: public
          forumId:
            type: integer
          directProjectId:
            type: integer
          screeningScorecardId:
            type: integer
          reviewScorecardId:
            type: integer
          isTask:
            type: boolean
          useSchedulingAPI:
            type: boolean
          pureV5Task:
            type: boolean
          selfService:
            type: boolean
          selfServiceCopilot:
            type: string
      billing:
        type: object
        properties:
          billingAccountId:
            type: string
          markup:
            type: number
            minimum: 0
            maximum: 100
      name:
        type: string
      description:
        type: string
      privateDescription:
        type: string
      challengeSource:
        type: string
      wiproAllowed:
        type: boolean
        default: false
        description: Flag to indicate whether Wipro employees can join challenge
      funChallenge:
        type: boolean
        default: false
        description: Flag to indicate this challenge contributes to leaderboard scoring without individual prize payouts
      descriptionFormat:
        type: string
        default: markup
      metadata:
        type: array
        items:
          properties:
            name:
              type: string
              description: The sample metadata type
            value:
              type: string
              description: The sample metadata value
          required:
            - name
            - value
      timelineTemplateId:
        type: string
        description: Required if the selected typeId/trackId combination does not have a default timeline template ID
        format: UUID
      phases:
        type: array
        items:
          $ref: "#/definitions/ChallengePhase"
      discussions:
        type: array
        items:
          $ref: "#/definitions/Discussion"
      events:
        type: array
        items:
          $ref: "#/definitions/Event"
      prizeSets:
        type: array
        items:
          $ref: "#/definitions/PrizeSets"
      tags:
        type: array
        items:
          type: string
      projectId:
        type: integer
        description: the project id
        minimum: 1
      legacyId:
        type: integer
        minimum: 1
      startDate:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      status:
        type: string
        description: the status
        enum:
          - NEW
          - DRAFT
          - CANCELLED
          - ACTIVE
          - COMPLETED
          - DELETED
          - CANCELLED_FAILED_REVIEW
          - CANCELLED_FAILED_SCREENING
          - CANCELLED_ZERO_SUBMISSIONS
          - CANCELLED_WINNER_UNRESPONSIVE
          - CANCELLED_CLIENT_REQUEST
          - CANCELLED_REQUIREMENTS_INFEASIBLE
          - CANCELLED_ZERO_REGISTRATIONS
      attachments:
        type: array
        items:
          $ref: "#/definitions/Attachment"
      groups:
        type: array
        items:
          type: string
          format: UUID
      winners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the winner placement
              example: 1
        required:
          - userId
          - handle
          - placement
      checkpointWinners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the checkpoint winner placement
              example: 1
          required:
            - userId
            - handle
            - placement
      terms:
        type: array
        description: The ids and roleId of the terms of use to add for the challenge
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
            roleId:
              type: string
              format: UUID
          required:
            - id
            - roleId
      numOfSubmissions:
        type: integer
        description: number of submissions
      numOfRegistrants:
        type: integer
        description: number of registrants
      currentPhaseNames:
        type: array
        items:
          type: string
      registrationStartDate:
        type: string
        format: date-time
      registrationEndDate:
        type: string
        format: date-time
      submissionStartDate:
        type: string
        format: date-time
      submissionEndDate:
        type: string
        format: date-time
      overview:
        description: the overview of the challenge
        type: object
        properties:
          totalPrizes:
            type: integer
      created:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      createdBy:
        type: string
        example: topcoder user
      updated:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      updatedBy:
        type: string
        example: topcoder user
      task:
        type: object
        properties:
          isTask:
            type: boolean
            default: false
          isAssigned:
            type: boolean
            default: false
          memberId:
            type: string
            default: null
            description: the ID of the assigned member
      type:
        type: string
        description: Auto-generated
        example: Challenge
      track:
        type: string
        description: Auto-generated
        example: Development
      payments:
        type: array
        description: The payments of the challenge, only applicable when "app-version" header >= 2.0.0 for admin/m2m user
        items:
          type: object
          properties:
            handle:
              type: string
            type:
              type: string
            amount:
              type: number
            userId:
              type: number
      skills:
        type: array
        description: The skills of the challenge, only applicable when "app-version" header >= 1.1.0
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
            name:
              type: string
            category:
              type: object
              properties:
                id:
                  type: string
                  format: UUID
                name:
                  type: string
    required:
      - typeId
      - trackId
      - name
      - descriptionFormat
      - timelineTemplateId
      - phases
      - created
      - createdBy
      - type
      - track
  ChallengeRequestBodyForCreate:
    type: object
    properties:
      typeId:
        type: string
        format: UUID
      trackId:
        type: string
        format: UUID
      legacy:
        type: object
        properties:
          reviewType:
            type: string
            enum:
              - "INTERNAL"
              - "COMMUNITY"
            default: "INTERNAL"
          confidentialityType:
            type: string
            default: public
          useSchedulingAPI:
            type: boolean
          pureV5Task:
            type: boolean
          selfService:
            type: boolean
          selfServiceCopilot:
            type: string
      billing:
        type: object
        properties:
          billingAccountId:
            type: string
          markup:
            type: number
            minimum: 0
            maximum: 100
      name:
        type: string
      description:
        type: string
      privateDescription:
        type: string
      challengeSource:
        type: string
      descriptionFormat:
        type: string
        default: markup
      metadata:
        type: array
        items:
          properties:
            name:
              type: string
              description: The sample metadata type
            value:
              type: string
              description: The sample metadata value
          required:
            - name
            - value
      timelineTemplateId:
        type: string
        description: Required if the selected typeId/trackId combination does not have a default timeline template ID
        format: UUID
      events:
        type: array
        items:
          $ref: "#/definitions/Event"
      phases:
        type: array
        items:
          properties:
            phaseId:
              type: string
              format: UUID
            duration:
              type: integer
              minimum: 0
      discussions:
        type: array
        items:
          $ref: "#/definitions/Discussion"
      prizeSets:
        type: array
        items:
          $ref: "#/definitions/PrizeSets"
      tags:
        type: array
        items:
          type: string
      projectId:
        type: integer
        description: the project id
        minimum: 1
      legacyId:
        type: integer
        minimum: 1
      startDate:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      status:
        type: string
        description: the status
        enum:
          - NEW
          - DRAFT
          - CANCELLED
          - ACTIVE
          - COMPLETED
          - DELETED
          - CANCELLED_FAILED_REVIEW
          - CANCELLED_FAILED_SCREENING
          - CANCELLED_ZERO_SUBMISSIONS
          - CANCELLED_WINNER_UNRESPONSIVE
          - CANCELLED_CLIENT_REQUEST
          - CANCELLED_REQUIREMENTS_INFEASIBLE
          - CANCELLED_ZERO_REGISTRATIONS
      groups:
        type: array
        items:
          type: string
          format: UUID
      terms:
        type: array
        description: The ids and roleId of the terms of use to add for the challenge
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
            roleId:
              type: string
              format: UUID
          required:
            - id
            - roleId
      skills:
        type: array
        description: The ids of the skills to add for the challenge, only applicable when "app-version" header >= 1.1.0
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
          required:
            - id
    required:
      - typeId
      - trackId
      - name
      - projectId
  ChallengeRequestBodyForFullyUpdate:
    type: object
    properties:
      typeId:
        type: string
        format: UUID
      trackId:
        type: string
        format: UUID
      legacy:
        type: object
        properties:
          reviewType:
            type: string
            enum:
              - "INTERNAL"
              - "COMMUNITY"
            default: "INTERNAL"
          confidentialityType:
            type: string
            default: public
          useSchedulingAPI:
            type: boolean
          pureV5Task:
            type: boolean
          selfService:
            type: boolean
          selfServiceCopilot:
            type: string
      cancelReason:
        type: string
      billing:
        type: object
        properties:
          billingAccountId:
            type: string
          markup:
            type: number
            minimum: 0
            maximum: 100
      task:
        type: object
        properties:
          isTask:
            type: boolean
            default: false
          isAssigned:
            type: boolean
            default: false
          memberId:
            type: string
            default: null
            description: the ID of the assigned member
      name:
        type: string
      description:
        type: string
      privateDescription:
        type: string
      challengeSource:
        type: string
      descriptionFormat:
        type: string
        default: markup
      metadata:
        type: array
        items:
          properties:
            name:
              type: string
              description: The sample metadata type
            value:
              type: string
              description: The sample metadata value
          required:
            - name
            - value
      timelineTemplateId:
        type: string
        description: Required if the selected typeId/trackId combination does not have a default timeline template ID
        format: UUID
      events:
        type: array
        items:
          $ref: "#/definitions/Event"
      phases:
        type: array
        items:
          properties:
            phaseId:
              type: string
              format: UUID
            duration:
              type: integer
              minimum: 0
            isOpen:
              type: boolean
      discussions:
        type: array
        items:
          $ref: "#/definitions/Discussion"
      prizeSets:
        type: array
        items:
          $ref: "#/definitions/PrizeSets"
      tags:
        type: array
        items:
          type: string
      projectId:
        type: integer
        description: the project id
        minimum: 1
      legacyId:
        type: integer
        minimum: 1
      startDate:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      status:
        type: string
        description: the status
        enum:
          - NEW
          - DRAFT
          - CANCELLED
          - ACTIVE
          - COMPLETED
          - DELETED
          - CANCELLED_FAILED_REVIEW
          - CANCELLED_FAILED_SCREENING
          - CANCELLED_ZERO_SUBMISSIONS
          - CANCELLED_WINNER_UNRESPONSIVE
          - CANCELLED_CLIENT_REQUEST
          - CANCELLED_REQUIREMENTS_INFEASIBLE
          - CANCELLED_ZERO_REGISTRATIONS
      attachments:
        type: array
        items:
          $ref: "#/definitions/Attachment"
      groups:
        type: array
        items:
          type: string
          format: UUID
      winners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the winner placement
              example: 1
          required:
            - userId
            - handle
            - placement
      checkpointWinners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the checkpoint winner placement
              example: 1
          required:
            - userId
            - handle
            - placement
      terms:
        type: array
        description: The ids and roleId of the terms of use to add for the challenge
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
            roleId:
              type: string
              format: UUID
          required:
            - id
            - roleId
      skills:
        type: array
        description: The ids of the skills to add for the challenge, only applicable when "app-version" header >= 1.1.0
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
          required:
            - id
    required:
      - typeId
      - trackId
      - name
      - projectId
      - status
  ChallengeRequestBodyForPartiallyUpdate:
    type: object
    properties:
      typeId:
        type: string
        format: UUID
      trackId:
        type: string
        format: UUID
      legacy:
        type: object
        properties:
          reviewType:
            type: string
            enum:
              - "INTERNAL"
              - "COMMUNITY"
            default: "INTERNAL"
          confidentialityType:
            type: string
            default: public
          useSchedulingAPI:
            type: boolean
          pureV5Task:
            type: boolean
          selfService:
            type: boolean
          selfServiceCopilot:
            type: string
      cancelReason:
        type: string
      billing:
        type: object
        properties:
          billingAccountId:
            type: string
          markup:
            type: number
            minimum: 0
            maximum: 100
      task:
        type: object
        properties:
          isTask:
            type: boolean
            default: false
          isAssigned:
            type: boolean
            default: false
          memberId:
            type: string
            default: null
            description: the ID of the assigned member
      name:
        type: string
      description:
        type: string
      privateDescription:
        type: string
      challengeSource:
        type: string
      descriptionFormat:
        type: string
        default: markup
      metadata:
        type: array
        items:
          properties:
            name:
              type: string
              description: The sample metadata type
            value:
              type: string
              description: The sample metadata value
          required:
            - name
            - value
      timelineTemplateId:
        type: string
        description: Required if the selected typeId/trackId combination does not have a default timeline template ID
        format: UUID
      events:
        type: array
        items:
          $ref: "#/definitions/Event"
      phases:
        type: array
        items:
          properties:
            phaseId:
              type: string
              format: UUID
            duration:
              type: integer
              minimum: 0
            isOpen:
              type: boolean
      discussions:
        type: array
        items:
          $ref: "#/definitions/Discussion"
      prizeSets:
        type: array
        items:
          $ref: "#/definitions/PrizeSets"
      tags:
        type: array
        items:
          type: string
      projectId:
        type: integer
        description: the project id
        minimum: 1
      legacyId:
        type: integer
        minimum: 1
      startDate:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      status:
        type: string
        description: the status
        enum:
          - NEW
          - DRAFT
          - CANCELLED
          - ACTIVE
          - COMPLETED
          - DELETED
          - CANCELLED_FAILED_REVIEW
          - CANCELLED_FAILED_SCREENING
          - CANCELLED_ZERO_SUBMISSIONS
          - CANCELLED_WINNER_UNRESPONSIVE
          - CANCELLED_CLIENT_REQUEST
          - CANCELLED_REQUIREMENTS_INFEASIBLE
          - CANCELLED_ZERO_REGISTRATIONS
      attachments:
        type: array
        items:
          $ref: "#/definitions/Attachment"
      groups:
        type: array
        items:
          type: string
          format: UUID
      winners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the winner placement
              example: 1
          required:
            - userId
            - handle
            - placement
      checkpointWinners:
        type: array
        items:
          properties:
            userId:
              type: integer
              description: The user id
            handle:
              type: string
              description: the user handle
            placement:
              type: integer
              minimum: 1
              description: the checkpoint winner placement
              example: 1
          required:
            - userId
            - handle
            - placement
      terms:
        type: array
        description: The ids and roleId of the terms of use to add for the challenge
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
            roleId:
              type: string
              format: UUID
          required:
            - id
            - roleId
      skills:
        type: array
        description: The ids of the skills to add for the challenge, only applicable when "app-version" header >= 1.1.0
        items:
          type: object
          properties:
            id:
              type: string
              format: UUID
          required:
            - id
  SearchChallengeRequestBody:
    type: object
    properties:
      ids:
        description: Array of challenge IDs
        type: array
        items:
          type: string
          format: UUID
        minItems: 1
        uniqueItems: true
      groups:
        description: Filter by group IDs
        type: array
        items:
          type: string
          format: UUID
        minItems: 1
        uniqueItems: true
  Event:
    type: object
    properties:
      id:
        type: number
      name:
        type: string
      key:
        type: string
    required:
      - id
  Discussion:
    type: object
    properties:
      id:
        type: string
        format: UUID
      name:
        type: string
      type:
        type: string
        enum:
          - challenge
      provider:
        type: string
      url:
        type: string
        format: url
        description: Only M2M tokens can modify this
      options:
        type: array
        description: Only M2M tokens can modify this
        items:
          type: object
    required:
      - name
      - type
      - provider
  PrizeSets:
    type: object
    properties:
      type:
        type: string
      description:
        type: string
      prizes:
        type: array
        items:
          properties:
            description:
              type: string
            type:
              type: string
            value:
              type: integer
              minimum: 0
          required:
            - type
            - value
    required:
      - type
  ChallengePhase:
    type: object
    properties:
      duration:
        type: integer
        minimum: 1
      scheduledStartDate:
        type: string
        format: date-time
      actualStartDate:
        type: string
        format: date-time
      scheduledEndDate:
        type: string
        format: date-time
      actualEndDate:
        type: string
        format: date-time
      isOpen:
        type: boolean
      phaseId:
        type: string
        format: UUID
      name:
        type: string
      id:
        type: string
        format: UUID
  ChallengeType:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The challenge type id.
            format: UUID
      - $ref: "#/definitions/ChallengeTypeData"
    required:
      - id
  ChallengeTypeData:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      isTask:
        type: boolean
        default: false
      abbreviation:
        type: string
      legacyId:
        type: integer
      isLegacy:
        type: boolean
        default: false
    required:
      - name
      - isActive
      - isTask
      - abbreviation
  ChallengeTypeDataPatch:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      isTask:
        type: boolean
        default: false
      abbreviation:
        type: string
      legacyId:
        type: integer
      isLegacy:
        type: boolean
  ChallengeTrack:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The challenge track id.
            format: UUID
      - $ref: "#/definitions/ChallengeTrackData"
    required:
      - id
  ChallengeTrackData:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      abbreviation:
        type: string
      legacyId:
        type: integer
      track:
        type: string
      isLegacy:
        type: boolean
        default: false
    required:
      - name
      - isActive
      - abbreviation
  ChallengeTrackDataPatch:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      abbreviation:
        type: string
      legacyId:
        type: integer
      track:
        type: string
      isLegacy:
        type: boolean
  Phase:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The challenge phase id.
            format: UUID
      - $ref: "#/definitions/PhaseData"
    required:
      - id
  PhaseData:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isOpen:
        type: boolean
      duration:
        type: integer
        minimum: 1
    required:
      - name
      - isOpen
      - duration
  PhaseDataPatch:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isOpen:
        type: boolean
      duration:
        type: integer
        minimum: 1
  TimelineTemplate:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The timeline template id.
            format: UUID
          typeId:
            type: string
            description: The challenge type id mapped to this timeline template row.
            format: UUID
          trackId:
            type: string
            description: The challenge track id mapped to this timeline template row.
            format: UUID
          isDefault:
            type: boolean
            description: Indicates this timeline template is the default for the mapped type/track.
            default: false
      - $ref: "#/definitions/TimelineTemplateData"
    required:
      - id
  TimelineTemplateData:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      phases:
        type: array
        items:
          properties:
            phaseId:
              type: string
              format: UUID
            predecessor:
              type: string
              format: UUID
            defaultDuration:
              type: number
              minimum: 1
          required:
            - phaseId
            - defaultDuration
    required:
      - name
      - isActive
      - phases
  TimelineTemplateDataPatch:
    type: object
    properties:
      name:
        type: string
      description:
        type: string
      isActive:
        type: boolean
      phases:
        type: array
        items:
          properties:
            phaseId:
              type: string
              format: UUID
            predecessor:
              type: string
              format: UUID
            defaultDuration:
              type: number
              minimum: 1
          required:
            - phaseId
            - defaultDuration
  ChallengeTimelineTemplate:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The challenge timeline template id.
            format: UUID
      - $ref: "#/definitions/ChallengeTimelineTemplateData"
    required:
      - id
  ChallengeTimelineTemplateData:
    type: object
    properties:
      typeId:
        type: string
        format: UUID
      trackId:
        type: string
        format: UUID
      timelineTemplateId:
        type: string
        format: UUID
      isDefault:
        type: boolean
        default: false
    required:
      - typeId
      - trackId
      - timelineTemplateId
  Attachment:
    type: object
    allOf:
      - type: object
        properties:
          id:
            type: string
            description: The attachment id.
            format: UUID
      - $ref: "#/definitions/AttachmentData"
    required:
      - id
  AttachmentData:
    type: object
    allOf:
      - type: object
        properties:
          challengeId:
            type: string
            format: UUID
      - $ref: "#/definitions/CreateUpdateAttachmentRequestBody"
    required:
      - challengeId
  PartiallyUpdateAttachmentRequestBody:
    type: object
    properties:
      name:
        type: string
      fileSize:
        type: integer
        minimum: 0
        default: 0
      url:
        type: string
        example: "https://cdn.filestackcontent.com/6NQ4A9nRUWLYY1Z4raew"
      description:
        type: string
  CreateUpdateAttachmentRequestBody:
    type: object
    properties:
      name:
        type: string
      fileSize:
        type: integer
        minimum: 0
        default: 0
      url:
        type: string
        format: url
        example: "https://cdn.filestackcontent.com/6NQ4A9nRUWLYY1Z4raew"
      description:
        type: string
    required:
      - url
      - name
  AuditLogEntry:
    type: object
    properties:
      id:
        type: string
        format: UUID
      challengeId:
        type: string
      fieldName:
        type: string
      oldValue:
        type: string
      newValue:
        type: string
      created:
        type: string
        format: date-time
        description: "ISO-8601 formatted date times (YYYY-MM-DDTHH:mm:ss.sssZ)"
      createdBy:
        type: string
        example: topcoder user
      memberId:
        type: string
        description: The member ID
        example: "12345678"
    required:
      - id
      - challengeId
      - fieldName
      - oldValue
      - newValue
      - created
      - createdBy
  ErrorModel:
    type: object
    properties:
      message:
        type: string
        description: the error message