openapi: 3.2.0
info:
  title: Deputy Memo API
  version: 1.0.0
  description: 'Operations tagged Memo across 2 of this provider''s published API definitions: deputy-openapi.json, deputy-memo-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.{region}.deputy.com/api/v1
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
tags:
- name: Memo
  description: V1 /my/memo/* endpoints
paths:
  /my/memo:
    get:
      tags:
      - Memo
      summary: List or get Memo
      operationId: my_memo__get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: Create or update Memo
      operationId: my_memo__post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/company/{id}:
    get:
      tags:
      - Memo
      summary: GET Memo / :id
      operationId: my_memo__company_id_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: POST Memo / :id
      operationId: my_memo__company_id_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/reactions/{orm}/{recId}:
    get:
      tags:
      - Memo
      summary: GET Memo / :recId
      operationId: my_memo__reactions_orm_recid_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: orm
        in: path
        required: true
        schema:
          type: string
      - name: recId
        in: path
        required: true
        schema:
          type: string
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/read:
    get:
      tags:
      - Memo
      summary: GET Memo / read
      operationId: my_memo__read_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/summary:
    get:
      tags:
      - Memo
      summary: GET Memo / summary
      operationId: my_memo__summary_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: POST Memo / summary
      operationId: my_memo__summary_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/team/{id}:
    get:
      tags:
      - Memo
      summary: GET Memo / :id
      operationId: my_memo__team_id_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: POST Memo / :id
      operationId: my_memo__team_id_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/unread:
    get:
      tags:
      - Memo
      summary: GET Memo / unread
      operationId: my_memo__unread_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/user/{id}:
    get:
      tags:
      - Memo
      summary: GET Memo / :id
      operationId: my_memo__user_id_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: POST Memo / :id
      operationId: my_memo__user_id_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/{id}:
    get:
      tags:
      - Memo
      summary: GET Memo / :id
      operationId: my_memo__id_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/{id}/comment:
    post:
      tags:
      - Memo
      summary: POST Memo / comment
      operationId: my_memo__id_comment_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/{id}/comment/{commentId}:
    delete:
      tags:
      - Memo
      summary: DELETE Memo / :commentId
      operationId: my_memo__id_comment_commentid_delete
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: commentId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/{memoId}/mark/read/{memoLogId}:
    post:
      tags:
      - Memo
      summary: POST Memo / :memoLogId
      operationId: my_memo__memoid_mark_read_memologid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: memoId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: memoLogId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /my/memo/{memoId}/mark/unread/{memoLogId}:
    post:
      tags:
      - Memo
      summary: POST Memo / :memoLogId
      operationId: my_memo__memoid_mark_unread_memologid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: memoId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: memoLogId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
  /resource/Memo:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: List Memo records
      description: Returns Memo records the authenticated caller is permitted to see. For large tables prefer POST /QUERY with pagination.
      operationId: listMemo
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/INFO:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: Get field metadata for Memo
      description: Returns the field list, types, and associations for this resource. Useful when building integrations that need to know which fields are queryable.
      operationId: infoMemo
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/PREDICT:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Memo
      summary: Predict-match a Memo record
      description: Returns the closest matching existing record for a partial payload. Used by upsert-style integrations to find an existing row before creating.
      operationId: predictMemo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Memo'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/QUERY:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Memo
      summary: Search Memo
      description: 'Flexible search endpoint. Body supports `search`, `sort`, `start`, `max`, and `join` clauses. Example: `{"search": {"s1": {"field": "Id", "data": 1, "type": "eq"}}}`.'
      operationId: searchMemo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/{id}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: Get a Memo by id
      operationId: getMemoById
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/{id}/COMMENTS:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: List comments on a Memo
      operationId: getCommentsMemo
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    Id:
                      type: integer
                    Comment:
                      type: string
                    Creator:
                      type: integer
                    Created:
                      type: string
                      format: date-time
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
    post:
      tags:
      - Memo
      summary: Add a comment to a Memo
      operationId: addCommentMemo
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Comment:
                  type: string
              required:
              - Comment
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/{id}/COMMENTS/{commentId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    delete:
      tags:
      - Memo
      summary: Delete a comment on a Memo
      operationId: deleteCommentMemo
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      - name: commentId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/{id}/HISTORY:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: Get change history for a Memo
      operationId: historyMemo
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /resource/Memo/{id}/HISTORY/travel/{timestamp}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: Get a Memo as it existed at a prior time
      operationId: historyMemoTravel
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        description: Numeric id of the resource
      - name: timestamp
        in: path
        required: true
        schema:
          type: integer
          format: int64
        description: Unix epoch seconds
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Memo'
        '400':
          description: Bad request
        '401':
          description: Authentication required or invalid token
        '403':
          description: Forbidden — token lacks access to this resource
        '404':
          description: Resource not found
      security:
      - BearerAuth: []
      - OAuth2: []
  /supervise/memo:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: List or get Memo
      operationId: supervise_memo__get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      security:
      - BearerAuth: []
    put:
      tags:
      - Memo
      summary: Create Memo
      operationId: supervise_memo__put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: Create or update Memo
      operationId: supervise_memo__post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/memo/{id}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    get:
      tags:
      - Memo
      summary: GET Memo / :id
      operationId: supervise_memo__id_get
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
    post:
      tags:
      - Memo
      summary: POST Memo / :id
      operationId: supervise_memo__id_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    put:
      tags:
      - Memo
      summary: PUT Memo / :id
      operationId: supervise_memo__id_put
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
    delete:
      tags:
      - Memo
      summary: DELETE Memo / :id
      operationId: supervise_memo__id_delete
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      security:
      - BearerAuth: []
  /supervise/memo/{id}/addRecipient:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Memo
      summary: POST Memo / addRecipient
      operationId: supervise_memo__id_addrecipient_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/memo/{memoId}/mark/read/{memoLogId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Memo
      summary: POST Memo / :memoLogId
      operationId: supervise_memo__memoid_mark_read_memologid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: memoId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: memoLogId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
  /supervise/memo/{memoId}/mark/unread/{memoLogId}:
    servers:
    - url: https://{subdomain}.{region}.deputy.com/api/v1
      description: Deputy tenant
      variables:
        subdomain:
          default: your-subdomain
        region:
          default: deputy
          enum:
          - au
          - eu
          - na
          - deputy
    post:
      tags:
      - Memo
      summary: POST Memo / :memoLogId
      operationId: supervise_memo__memoid_mark_unread_memologid_post
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad request
        '401':
          description: Not authenticated
        '403':
          description: Insufficient permissions
        '404':
          description: Not found
      parameters:
      - name: memoId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      - name: memoLogId
        in: path
        required: true
        schema:
          type: integer
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - BearerAuth: []
components:
  schemas:
    Memo:
      type: object
      properties:
        Id:
          type: integer
        ShowFrom:
          type: string
          format: date-time
        Active:
          type: boolean
        ShowTill:
          type: string
          format: date-time
        Title:
          type: string
          maxLength: 255
        Content:
          type: string
        Type:
          type: integer
        File:
          type: integer
        Url:
          type: string
          maxLength: 255
        ConfirmText:
          type: string
          maxLength: 255
        Keyword:
          type: string
        DisableComment:
          type: boolean
        Creator:
          type: integer
        Created:
          type: string
          format: date-time
        Modified:
          type: string
        CreatorObject:
          type: object
      required:
      - Id
      - ShowFrom
      - Active
      - Type
      - ConfirmText
      - Modified
    QueryRequest:
      type: object
      description: V1 Resource search payload. All fields optional; an empty body returns the first page of results.
      properties:
        search:
          type: object
          description: Map of search clauses keyed by an arbitrary id (e.g. `s1`, `s2`). Each clause filters one field.
          additionalProperties:
            type: object
            required:
            - field
            - data
            - type
            properties:
              field:
                type: string
                description: Field name to filter on (e.g. `Id`, `Employee`).
              data:
                description: Comparison value. Type depends on the field.
              type:
                type: string
                description: Comparison operator.
                enum:
                - eq
                - ne
                - gt
                - lt
                - ge
                - le
                - is
                - is not
                - in
                - not in
                - starts
                - contains
        sort:
          type: object
          description: Map of field name → `asc` or `desc`.
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
        start:
          type: integer
          minimum: 0
          default: 0
          description: Pagination offset (0-indexed).
        max:
          type: integer
          minimum: 1
          maximum: 500
          default: 100
          description: Max records per page (server caps at 500).
        join:
          type: array
          items:
            type: string
          description: Related ORMs to expand inline (e.g. `["EmployeeObject"]`).
      example:
        search:
          s1:
            field: Id
            data: 1
            type: ge
        max: 100
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token or Deputy Permanent Token.
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://once.deputy.com/my/oauth/login
          tokenUrl: https://once.deputy.com/my/oauth/access_token
          scopes:
            longlife_refresh_token: Extended session
x-refined-from:
- deputy-openapi.json
- deputy-memo-api-openapi.yml