openapi: 3.2.0
info:
  description: Miscellaneous Accela API
  title: Miscellaneous Conditions API
  version: v4
servers:
- url: https://apis.accela.com/
tags:
- name: Conditions
  description: '**Conditions**


    The system provides standard conditions

    for different record types(permits, licenses, inspections, and so forth).'
paths:
  /v4/conditions/standard:
    get:
      description: 'Gets the standard conditions available in the system.


        **API Endpoint**: GET /v4/conditions/standard


        **Scope**: conditions


        **App Type**: Agency


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Standard Conditions
      operationId: v4.get.conditions.standard
      tags:
      - Conditions
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: Filter by the standard condition type. See [Get All Standard Condition Types](./api-settings.html#operation/v4.get.settings.conditions.types).
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter by standard condition group.
        in: query
        name: group
        required: false
        schema:
          type: string
      - description: Filter by standard condition name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Filter by standard condition severity.
        in: query
        name: severity
        required: false
        schema:
          type: string
      - description: Filter by standard condition public display message.
        in: query
        name: publicDisplayMessage
        required: false
        schema:
          type: string
      - description: Filter whether or not the standard condition is inheritable.
        in: query
        name: inheritable
        required: false
        schema:
          type: string
          enum:
          - Y
          - N
      - description: Filter by standard condition priority. See [Get All Standard Condition Priorities](./api-settings.html#operation/v4.get.settings.conditions.priorities).
        in: query
        name: priority
        required: false
        schema:
          type: integer
          format: int64
      - description: Filter by standard condition short comments.
        in: query
        name: shortComments
        required: false
        schema:
          type: string
      - description: Filter by standard condition long comments.
        in: query
        name: longComments
        required: false
        schema:
          type: string
      - description: Filter by standard condition  resolution action
        in: query
        name: resolutionAction
        required: false
        schema:
          type: string
      - description: Filter whether or not the standard condition includes name in notice.
        in: query
        name: includeNameInNotice
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition includes short comments in notice.
        in: query
        name: includeShortCommentsInNotice
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice to the agency.
        in: query
        name: displayNoticeInAgency
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice to the citizens.
        in: query
        name: displayNoticeInCitizens
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice in the citizen fee.
        in: query
        name: displayNoticeInCitizensFee
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - description: Sort search result by one field name.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: The sort direction. Default is ASC.
        in: query
        name: direction
        required: false
        schema:
          type: string
          enum:
          - ASC
          - ' DESC'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: "Successful request. \n\nNote: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_conditionModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/conditionApprovals/standard:
    get:
      description: 'Gets the conditions of approval available in the system.


        **API Endpoint**: GET /v4/conditionApprovals/standard


        **Scope**: conditions


        **App Type**: Agency


        **Authorization Type**: Access token


        **Civic Platform version**: 7.3.2'
      summary: Get All Approval Conditions
      operationId: v4.get.conditionApprovals.standard
      tags:
      - Conditions
      parameters:
      - $ref: '#/components/parameters/authHeaderParam'
      - description: Filter by the standard condition type. See [Get All Standard Condition Types](./api-settings.html#operation/v4.get.settings.conditions.types).
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Filter by standard condition group.
        in: query
        name: group
        required: false
        schema:
          type: string
      - description: Filter by standard condition name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Filter by standard condition severity.
        in: query
        name: severity
        required: false
        schema:
          type: string
      - description: Filter by standard condition public display message.
        in: query
        name: publicDisplayMessage
        required: false
        schema:
          type: string
      - description: Filter whether or not the standard condition is inheritable.
        in: query
        name: inheritable
        required: false
        schema:
          type: string
          enum:
          - Y
          - N
      - description: Filter by standard condition priority. See [Get All Standard Condition Priorities](./api-settings.html#operation/v4.get.settings.conditions.priorities).
        in: query
        name: priority
        required: false
        schema:
          type: integer
          format: int64
      - description: Filter by standard condition short comments.
        in: query
        name: shortComments
        required: false
        schema:
          type: string
      - description: Filter by standard condition long comments.
        in: query
        name: longComments
        required: false
        schema:
          type: string
      - description: Filter by standard condition  resolution action
        in: query
        name: resolutionAction
        required: false
        schema:
          type: string
      - description: Filter whether or not the standard condition includes name in notice.
        in: query
        name: includeNameInNotice
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition includes short comments in notice.
        in: query
        name: includeShortCommentsInNotice
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice to the agency.
        in: query
        name: displayNoticeInAgency
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice to the citizens.
        in: query
        name: displayNoticeInCitizens
        required: false
        schema:
          type: boolean
      - description: Filter whether or not the standard condition displays the notice in the citizen fee.
        in: query
        name: displayNoticeInCitizensFee
        required: false
        schema:
          type: boolean
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/limit'
      - description: Sort search result by one field name.
        in: query
        name: sort
        required: false
        schema:
          type: string
      - description: The sort direction. Default is ASC.
        in: query
        name: direction
        required: false
        schema:
          type: string
          enum:
          - ASC
          - ' DESC'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: "Successful request. \n\nNote: A successful request may return no data matching the filter criteria. A successful request may also return messages related to Event Manager Scripting Engine back-end processing."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_conditionApprovalModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
components:
  schemas:
    response_conditionModelArray:
      type: object
      properties:
        result:
          items:
            $ref: '#/components/schemas/conditionModel'
          type: array
        status:
          type: integer
          description: The HTTP return status.
    response_conditionApprovalModelArray:
      type: object
      properties:
        result:
          items:
            $ref: '#/components/schemas/conditionModel'
          type: array
        status:
          type: integer
          description: The HTTP return status.
    conditionModel:
      type: object
      properties:
        actionbyDepartment:
          type: object
          description: The department responsible for the action.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        actionbyUser:
          type: object
          description: The individual responsible for the action.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        activeStatus:
          type: object
          description: Indicates whether or not the condition is active.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        additionalInformation:
          description: An unlimited text field to use if other fields are filled.
          type: string
        additionalInformationPlainText:
          description: An unlimited text field to use if other fields are filled.
          type: string
        appliedDate:
          description: The date the standard condition was applied.
          format: date-time
          type: string
        appliedbyDepartment:
          type: object
          description: The department responsible for applying a condition.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        appliedbyUser:
          type: object
          description: The staff member responsible for applying a condition.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        dispAdditionalInformationPlainText:
          description: An unlimited text field to use if other fields are filled.
          type: string
        displayNoticeInAgency:
          description: Indicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.
          type: boolean
        displayNoticeInCitizens:
          description: Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.
          type: boolean
        displayNoticeInCitizensFee:
          description: Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when a condition to a record or parcel is applied.
          type: boolean
        effectiveDate:
          description: The date when you want the condition to become effective.
          format: date-time
          type: string
        expirationDate:
          description: The date when the condition expires.
          format: date-time
          type: string
        group:
          type: object
          description: The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        id:
          description: The condition system id assigned by the Civic Platform server.
          format: int64
          type: integer
        inheritable:
          type: object
          description: This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        isIncludeNameInNotice:
          description: Indicates whether or not to display the condition name in the notice.
          type: boolean
        isIncludeShortCommentsInNotice:
          description: Indicates whether or not to display the condition comments in the notice.
          type: boolean
        longComments:
          description: Narrative comments to help identify the purpose or uses of the standard condition.
          type: string
        name:
          description: The name of the standard condition.
          type: string
        priority:
          type: object
          description: The priority level assigned to the condition.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        publicDisplayMessage:
          description: Text entered into this field displays in the condition notice or condition status bar for the Condition Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).
          type: string
        resAdditionalInformationPlainText:
          description: An unlimited text field to use if other fields are filled.
          type: string
        resolutionAction:
          description: he action performed in response to a condition.
          type: string
        serviceProviderCode:
          description: The unique agency identifier.
          type: string
        severity:
          type: object
          description: The severity of the condition.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        shortComments:
          description: A brief description of the condition name. For example, the text may describe the situation that requires the system to apply the condition. You can set these short comments to display when a user accesses an application with this condition applied to it
          type: string
        status:
          type: object
          description: The condition status.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        statusDate:
          description: The date when the current status changed.
          format: date-time
          type: string
        statusType:
          description: The status type for a standard condition or an approval condition, applied or not applied for example.
          type: string
        type:
          type: object
          description: The condition type.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
  parameters:
    fields:
      description: 'Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.'
      in: query
      name: fields
      required: false
      schema:
        type: string
    authHeaderParam:
      description: Construct oAuth2 authentication token
      in: header
      name: Authorization
      required: true
      schema:
        type: string
    offset:
      description: The offset position of the first record in the results response array. For example, if offset is 100, the first item in the results array in the response is the 100th record in the search result list.
      in: query
      name: offset
      required: false
      schema:
        type: integer
        format: int64
    lang:
      description: Language parameter to support I18N. Default language is en_US.
      in: query
      name: lang
      required: false
      schema:
        type: string
    limit:
      description: Search result size limit.
      in: query
      name: limit
      required: false
      schema:
        type: integer
        format: int64
x-api-evangelist-provenance:
  generated: '2026-09-06'
  method: searched
  source: https://developer.accela.com/api/v4/v4-misc.json
  note: Harvested verbatim from the Accela Developer Portal API Reference, which renders these Swagger 2.0 documents via ReDoc (spec-url on developer.accela.com/docs/api_reference/api-*.html). The byte-identical original is kept at openapi/_original/. This copy is the same document serialized to YAML.