Actionstep Participant Relationship Types API

openapi: 3.0.3
info:
  title: Action (Matter) Bill Settings Action Bill Settings Participant Relationship Types 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: Participant Relationship Types
paths:
  /participantrelationshiptypes:
    get:
      description: Returns a list of all Participant Relationship Types.
      tags:
      - Participant Relationship Types
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/participantrelationshiptypes'
    post:
      description: Create a new participant relationship type.
      tags:
      - Participant Relationship Types
      requestBody:
        $ref: '#/components/requestBodies/CreateParticipantRelationshipType'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantRelationshipType'
  /participantrelationshiptypes/{id}:
    get:
      description: Returns a single participant relationship type.
      tags:
      - Participant Relationship Types
      parameters:
      - name: id
        in: path
        description: Unique identifier for the participant relationship type. This is a composite key composed from the category and relationship properties, separated by '--'.
        required: true
        schema:
          type: string
        example: IndividualToIndividual--Acquaintance
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantRelationshipType'
    delete:
      description: Delete a single participant relationship type.
      tags:
      - Participant Relationship Types
      parameters:
      - name: id
        in: path
        description: Unique identifier for the participant relationship type. This is a composite key composed from the category and relationship properties, separated by '--'.
        required: true
        schema:
          type: string
        example: IndividualToIndividual--Acquaintance
      responses:
        '204':
          description: Success, No content.
components:
  schemas:
    ParticipantRelationshipType:
      type: object
      properties:
        category:
          description: The category for the relationship type.
          enum:
          - IndividualToIndividual
          - IndividualToCompany
          - CompanyToIndividual
          - CompanyToCompany
          type: string
          format: string
          example: IndividualToIndividual
        relationshipType:
          description: The name for the relationship type.
          type: string
          format: string
          example: Acquaintance
    ParticipantRelationshipTypePageData:
      type: object
      properties:
        recordCount:
          description: The total number of Participant Relationship Types returned by the underlying query.
          type: integer
          example: 4
        pageCount:
          description: The total number of pages generated by the underlying query.
          type: integer
          example: 8
        page:
          description: The page number for this page of Participant Relationship Types.
          type: integer
          example: 2
        pageSize:
          description: Page size.
          type: integer
          example: 50
        prevPage:
          description: A URL to the previous page of Participant Relationship Types.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/participantrelationshiptypes?page=1
        nextPage:
          description: A URL to the next page of Participant Relationship Types.
          type: string
          example: https://ap-southeast-2.actionstep.com/api/rest/participantrelationshiptypes?page=3
    PagingData:
      type: object
      properties:
        participantrelationshiptypes:
          $ref: '#/components/schemas/ParticipantRelationshipTypePageData'
    participantrelationshiptypes:
      type: object
      properties:
        participantrelationshiptypes:
          type: array
          items:
            $ref: '#/components/schemas/ParticipantRelationshipType'
        meta:
          $ref: '#/components/schemas/PageMetaData'
    PageMetaData:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/PagingData'
    CreateParticipantRelationshipType:
      type: object
      required:
      - category
      - relationship
      properties:
        category:
          description: The category for the relationship type.
          enum:
          - IndividualToIndividual
          - IndividualToCompany
          - CompanyToIndividual
          - CompanyToCompany
          type: string
          format: string
          example: IndividualToIndividual
        relationshipType:
          description: The name for the relationship type. A relationship type must be unique within a category.
          type: string
          format: string
          example: Acquaintance
  requestBodies:
    CreateParticipantRelationshipType:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateParticipantRelationshipType'
externalDocs:
  description: API Developer Portal - Constructing API Requests
  url: https://docs.actionstep.com/api-requests/