openapi: 3.0.3

info:
  title: Data Collection Field Dropdown Choices
  description: "Use this endpoint to manage the choices for a dropdown field. For information on how to construct requests utilising fieldsets, sorting, paging, filters, and '*includes*', please refer to the API Developer Portal. E&OE."
  version: "1.0"

paths:
  '/datacollectionfielddropdownchoices':
    get:
      description: Returns the collection of all data collection field dropdown choice records.
      tags:
        - Data Collection Field Dropdown Choices
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDataCollectionFieldDropdownChoices'

    post:
      description: Create a new data collection field dropdown choice record.
      tags:
        - Data Collection Field Dropdown Choices
      requestBody:
        $ref: '#/components/requestBodies/CreateDataCollectionFieldDropdownChoiceRecord'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecord'

  '/datacollectionfielddropdownchoices/{id}':
    get:
      description: Returns a single data collection field dropdown choice record.
      tags:
        - Data Collection Field Dropdown Choices
      parameters:
        - name: id
          in: path
          description: Unique identifier for a single data collection field dropdown choice record. Note the unique identifier is a composite primary key comprising of the data collection identifier, the data field name, and the name associated with the dropdown choice, delimited by '--'.
          required: true
          schema:
            type: string
            format: string
          example: 230--CarColor--Red
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecord'

    put:
      description: Updates a single data collection field dropdown choice record.
      tags:
        - Data Collection Field Dropdown Choices
      parameters:
        - name: id
          in: path
          description: Unique identifier for a single data collection field dropdown choice record. Note the unique identifier is a composite primary key comprising of the data collection identifier, the data field name, and the name associated with the dropdown choice, delimited by '--'.
          required: true
          schema:
            type: string
            format: string
          example: 230--CarColor--Red
      requestBody:
        $ref: '#/components/requestBodies/UpdateDataCollectionFieldDropdownChoiceRecord'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecord'

    delete:
      description: Delete a single data collection field dropdown choice record.
      tags:
        - Data Collection Field Dropdown Choices
      parameters:
        - name: id
          in: path
          description: Unique identifier for a single data collection field dropdown choice record. Note the unique identifier is a composite primary key comprising of the data collection identifier, the data field name, and the name associated with the dropdown choice, delimited by '--'.
          required: true
          schema:
            type: string
            format: string
          example: 230--CarColor--Red
      responses:
        '204':
          description: Success, No Content.

components:
  schemas:
    PagedDataCollectionFieldDropdownChoices:
      type: object
      properties:
        datacollectionfielddropdownchoices:
          type: array
          items:
            $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecord'
        meta:
          $ref: '#/components/schemas/PageMetaData'

    PageMetaData:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingData'

    PagingData:
      type: object
      properties:
        datacollectionfielddropdownchoices:
          $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecordPageData'

    DataCollectionFieldDropdownChoiceRecordPageData:
      type: object
      properties:
        recordCount:
          description: The total number of data collection field dropdown choice records returned by the underlying query.
          type: integer
          example: 2487
        pageCount:
          description: The total number of pages generated by the underlying query.
          type: integer
          example: 50
        page:
          description: The page number for this page of data collection field dropdown choices.
          type: integer
          example: 2
        pageSize:
          description: Page size.
          type: integer
          example: 50
        prevPage:
          description: A URL to the previous page of data collection field dropdown choice records.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/datacollectionfielddropdownchoices?page=1
        nextPage:
          description: A URL to the next page of data collection field dropdown choice records.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/datacollectionfielddropdownchoices?page=3

    DataCollectionFieldDropdownChoiceRecord:
      type: object
      properties:
        id:
          description: Unique identifier for a single data collection field dropdown choice record. Note the unique identifier is a composite primary key comprising of the data collection identifier, the data field name, and the name associated with the dropdown choice, delimited by '--'.
          type: string
          format: string
          example: 230--CarColor--Red        
          readOnly: true
        name:
          description: The name associated with the choice. The name property is displayed in the dropdown list.
          type: string
          format: string
          example: Metallic Red
        value:
          description: The value for the choice.
          type: string
          format: string
          example: red
        listOrder:
          description: The order in which choices are displayed in the dropdown list. Choices with the same listOrder value are displayed in alphabetical order based on the name property.
          type: integer
          format: integer
          default: 0
          example: 3
        isDefault:
          description: Indicates a default choice. Only one item in a dropdown choice list can be marked as default.
          enum:
          - T
          - F
          type: string
          format: string
          example: T
        parentValue:
          description: Used when creating hierarchical custom data fields to limit the displayed choices based on the value selected in a parent dropdown list. See [Creating Hierarchical Custom Data Fields](https://support.actionstep.com/support/solutions/articles/150000188403-creating-hierarchical-custom-data-fields-admin-) for further information.
          type: string
          format: string
          example: Country
        links:
          $ref: '#/components/schemas/DataCollectionFieldDropdownChoiceRecordLinks'

    DataCollectionFieldDropdownChoiceRecordLinks:
      type: object
      properties:
        dataField:
          description: Unique identifier for a single data collection field. Note the unique identifier is a composite primary key comprising of the data collection identifier and the data field name, delimited by '--'.
          type: string
          format: string
          example: 230--CarColor
        dataCollection:
          description: Unique identifier for the parent data collection.
          type: integer
          format: string
          example: 230

    CreateDataCollectionFieldDropdownChoiceRecord:
      type: object
      required:
        - name
        - value
        - listOrder
        - isDefault
      properties:
        name:
          description: The name associated with the choice. The name property is displayed in the dropdown list.
          type: string
          format: string
          example: Metallic Red
        value:
          description: The value for the choice.
          type: string
          format: string
          example: red
        listOrder:
          description: The order in which choices are displayed in the dropdown list. Choices with the same listOrder value are displayed in alphabetical order based on the name property.
          type: integer
          format: integer
          default: 0
          example: 3
        isDefault:
          description: Indicates a default choice. Only one item in a dropdown choice list can be marked as default.
          enum:
          - T
          - F
          type: string
          format: string
          example: T
        parentValue:
          description: Used when creating hierarchical custom data fields to limit the displayed choices based on the value selected in a parent dropdown list. See [Creating Hierarchical Custom Data Fields](https://support.actionstep.com/support/solutions/articles/150000188403-creating-hierarchical-custom-data-fields-admin-) for further information.
          type: string
          format: string
          example: Country
        links:
          $ref: '#/components/schemas/CreateDataCollectionFieldDropdownChoiceRecordLinks'

    CreateDataCollectionFieldDropdownChoiceRecordLinks:
      type: object
      required:
        - dataField
      properties:
        dataField:
          description: Unique identifier for a single data collection field. Note the unique identifier is a composite primary key comprising of the data collection identifier and the data field name, delimited by '--'.
          type: string
          format: string
          example: 230--CarColor
        dataCollection:
          description: Unique identifier for the parent data collection.
          type: integer
          format: string
          example: 230

    UpdateDataCollectionFieldDropdownChoiceRecord:
      type: object
      properties:
        name:
          description: The name associated with the choice. The name property is displayed in the dropdown list.
          type: string
          format: string
          example: Metallic Red
        value:
          description: The value for the choice.
          type: string
          format: string
          example: red
        listOrder:
          description: The order in which choices are displayed in the dropdown list. Choices with the same listOrder value are displayed in alphabetical order based on the name property.
          type: integer
          format: integer
          default: 0
          example: 3
        isDefault:
          description: Indicates a default choice. Only one item in a dropdown choice list can be marked as default.
          enum:
          - T
          - F
          type: string
          format: string
          example: T
        parentValue:
          description: Used when creating hierarchical custom data fields to limit the displayed choices based on the value selected in a parent dropdown list. See [Creating Hierarchical Custom Data Fields](https://support.actionstep.com/support/solutions/articles/150000188403-creating-hierarchical-custom-data-fields-admin-) for further information.
          type: string
          format: string
          example: Country
        links:
          $ref: '#/components/schemas/UpdateDataCollectionFieldDropdownChoiceRecordLinks'

    UpdateDataCollectionFieldDropdownChoiceRecordLinks:
      type: object
      properties:
        dataField:
          description: Unique identifier for a single data collection field. Note the unique identifier is a composite primary key comprising of the data collection identifier and the data field name, delimited by '--'.
          type: string
          format: string
          example: 230--CarColor
        dataCollection:
          description: Unique identifier for the parent data collection.
          type: integer
          format: string
          example: 230

  requestBodies:
    CreateDataCollectionFieldDropdownChoiceRecord:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateDataCollectionFieldDropdownChoiceRecord'

    UpdateDataCollectionFieldDropdownChoiceRecord:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateDataCollectionFieldDropdownChoiceRecord'