Actionstep Data Collection Record Values API

openapi: 3.0.3
info:
  title: Action (Matter) Bill Settings Action Bill Settings Data Collection Record Values API
  description: For retrieving Action Bill Settings. For historical reasons Matters are referred to as *actions* in this version of the API. For information of how to construct requests utilising fieldsets, sorting, paging, filters, and '*includes*', please refer to the API Developer Portal. E&OE.
  version: '1.0'
tags:
- name: Data Collection Record Values
paths:
  /datacollectionrecordvalues:
    get:
      description: Returns a collection of data collection record values.
      tags:
      - Data Collection Record Values
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedDataCollectionRecordValues'
    post:
      description: Create a new data collection record value.
      tags:
      - Data Collection Record Values
      requestBody:
        $ref: '#/components/requestBodies/CreateDataCollectionRecordValue'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionRecordValue'
  /datacollectionrecordvalues/{id}:
    get:
      description: Returns a single data collection record value.
      tags:
      - Data Collection Record Values
      parameters:
      - name: id
        in: path
        description: Unique identifier for a data collection record value.
        required: true
        schema:
          type: integer
          format: int32
        example: 380
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionRecordValue'
    put:
      description: Update a data collection record value.
      tags:
      - Data Collection Record Values
      parameters:
      - name: id
        in: path
        description: Unique identifier for a data collection record value.
        required: true
        schema:
          type: integer
          format: int32
        example: 608
      requestBody:
        $ref: '#/components/requestBodies/UpdateDataCollectionRecordValue'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataCollectionRecordValue'
components:
  requestBodies:
    UpdateDataCollectionRecordValue:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateDataCollectionRecordValue'
    CreateDataCollectionRecordValue:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateDataCollectionRecordValue'
  schemas:
    DataCollectionRecordValueLinks:
      type: object
      properties:
        action:
          description: Unique identifier of the matter to which the data collection field value is associated.
          example: 500
          type: integer
        dataCollectionField:
          description: Unique identifier for the data collection field. This is a composite unique identifier composed from the data collection unique identifier and the data field name, separated by a '--' delimiter.
          example: 148--victim_age
          format: string
          type: string
        dataCollectionRecord:
          description: Unique identifier for the data record.
          example: 6234
          type: integer
        dataCollection:
          description: Unique identifier of the data collection to which the data collection record is associated.
          example: 148
          type: integer
    PagingData:
      type: object
      properties:
        datacollectionrecordvalues:
          $ref: '#/components/schemas/DataCollectionRecordValuesPageData'
    DataCollectionRecordValuesPageData:
      type: object
      properties:
        recordCount:
          description: The total number of data collection record values 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 record values.
          type: integer
          example: 2
        pageSize:
          description: Page size.
          type: integer
          example: 50
        prevPage:
          description: A URL to the previous page of data collection record values.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/datacollectionrecordvalues?page=1
        nextPage:
          description: A URL to the next page of data collection record values.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/datacollectionrecordvalues?page=3
    PagedDataCollectionRecordValues:
      type: object
      properties:
        datacollectionrecordvalues:
          type: array
          items:
            $ref: '#/components/schemas/DataCollectionRecordValue'
        meta:
          $ref: '#/components/schemas/PageMetaData'
    CreateDataCollectionRecordValue:
      type: object
      required:
      - stringValue
      properties:
        stringValue:
          description: Data field value as a string.
          example: 2023-12-25
          format: string
          type: string
        last_modified_time_stamp:
          description: Date and time the data field value is created.
          example: 2023-06-03 00:09:30+12:00
          format: timestamp
          type: string
        last_modified_by_user_id:
          description: Unique identifier for the Actionstep user who is creating the data field value.
          example: 7837
          type: integer
        links:
          $ref: '#/components/schemas/CreateDataCollectionRecordValueLinks'
    UpdateDataCollectionRecordValueLinks:
      type: object
      properties:
        action:
          description: Unique identifier of the matter to which the data collection field value is associated.
          example: 500
          type: integer
        dataCollectionField:
          description: Unique identifier for the data collection field. This is a composite unique identifier composed from the data collection unique identifier and the data field name, separated by a '--' delimiter.
          example: 148--victim_age
          format: string
          type: string
        dataCollectionRecord:
          description: Unique identifier for the data record.
          example: 6234
          type: integer
        dataCollection:
          description: Unique identifier of the data collection to which the data collection record is associated.
          example: 148
          type: integer
    UpdateDataCollectionRecordValue:
      type: object
      required:
      - stringValue
      properties:
        stringValue:
          description: Data field value as a string.
          example: 2023-12-25
          format: string
          type: string
        last_modified_time_stamp:
          description: Date and time the data field value is modified.
          example: 2023-06-03 00:09:30+12:00
          format: timestamp
          type: string
        last_modified_by_user_id:
          description: Unique identifier for the Actionstep user who is modifying the data field value.
          example: 7837
          type: integer
        links:
          $ref: '#/components/schemas/UpdateDataCollectionRecordValueLinks'
    PageMetaData:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingData'
    DataCollectionRecordValue:
      type: object
      properties:
        id:
          description: Unique identifier for the data collection record value. This is a composite identifier constructed from the data collection unique identifier, the data field name, and the data collection record unique identifier, all separated by a '--' delimiter.
          example: 148--victim_age--6234
          type: string
          format: string
          readOnly: true
        stringValue:
          description: Data field value as a string.
          example: 2023-12-25
          format: string
          type: string
        last_modified_time_stamp:
          description: Date and time the data field value was last modified.
          example: 2023-06-03 00:09:30+12:00
          format: timestamp
          type: string
        last_modified_by_user_id:
          description: Unique identifier for the Actionstep user who last modified the data field value.
          example: 7837
          type: integer
        links:
          $ref: '#/components/schemas/DataCollectionRecordValueLinks'
    CreateDataCollectionRecordValueLinks:
      type: object
      required:
      - action
      - dataCollectionField
      - dataCollectionRecord
      - dataCollection
      properties:
        action:
          description: Unique identifier of the matter to which the data collection field value is associated.
          example: 500
          type: integer
        dataCollectionField:
          description: Unique identifier for the data collection field. This is a composite unique identifier composed from the data collection unique identifier and the data field name, separated by a '--' delimiter.
          example: 148--victim_age
          format: string
          type: string
        dataCollectionRecord:
          description: Unique identifier for the data collection record.
          example: 6234
          type: integer
        dataCollection:
          description: Unique identifier of the data collection to which the data collection record is associated.
          example: 148
          type: integer
externalDocs:
  description: API Developer Portal - Constructing API Requests
  url: https://docs.actionstep.com/api-requests/