swagger: '2.0'
info:
  description: "\n\n## Overview\n\n\n\nThis application offers an API for managing assignments and tasks.\n\n\n\nGraphQL endpoint for the same API is [also available](/graph)\n\n\n\n<details><summary>Authentication</summary>\n\n\n\n> \n\n> Authenticate using your Erply credentials and get a sessionKey. This sessionKey and your Erply clientCode must be provided in the HTTP headers of every request. You do not have to authenticate against this API - valid Erply sessionKey-s from other sources are also acceptable. To authenticate using this API, use the `POST /api/v1/auth` endpoint.\n\n>\n\n</details>\n\n"
  title: assignments Assortment External IDs API
  contact: {}
  version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: External IDs
paths:
  /v1/external-ids:
    get:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Currently supported entities: category'
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - External IDs
      summary: Read external IDs
      parameters:
      - type: array
        items:
          type: string
        description: up to 100 external IDs
        name: externalIds
        in: query
      - type: array
        items:
          type: string
        description: up to 100 object IDs
        name: objIds
        in: query
      - type: string
        description: 'Entity name to filter by (currently supported: category)'
        name: entityName
        in: query
        required: true
      - type: string
        description: integration name
        name: integrationName
        in: query
        required: true
      - type: integer
        description: skip n records
        name: skip
        in: query
      - type: integer
        description: 'items to take, default: 20, max: 100000'
        name: take
        in: query
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/models.ExternalIDResponse'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/responses.MessageResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/responses.MessageResponse'
  /v1/external-ids/{entityName}/{objIds}:
    delete:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Currently supported entities: category'
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - External IDs
      summary: Delete external IDs of entities
      parameters:
      - type: string
        description: Specify the integration name to delete the external ID associated with the integration only.
        name: integrationName
        in: query
        required: true
      - type: string
        description: 'Entity name (currently supported: category)'
        name: entityName
        in: path
        required: true
      - type: string
        description: up to 100 semicolon delimited ids
        name: objIds
        in: path
        required: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/responses.Response'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/responses.MessageResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/responses.MessageResponse'
  /v1/external-ids/{entityName}/{objId}:
    patch:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Currently supported entities: category'
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - External IDs
      summary: Update external ID of an entity
      parameters:
      - description: request
        name: externalIdWithIntegrationName
        in: body
        required: true
        schema:
          $ref: '#/definitions/models.ExternalIDPatchRequest'
      - type: string
        description: 'Entity name (currently supported: category)'
        name: entityName
        in: path
        required: true
      - type: integer
        description: Object ID
        name: objId
        in: path
        required: true
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/responses.Response'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/responses.MessageResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/responses.MessageResponse'
  /v1/external-ids/{objId}:
    post:
      security:
      - sk: []
      - cc: []
      - jwt: []
      description: 'Currently supported entities: category'
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - External IDs
      summary: Attach external ID to an entity
      parameters:
      - description: request
        name: externalIdWithIntegrationName
        in: body
        required: true
        schema:
          $ref: '#/definitions/models.ExternalIDPatchRequest'
      - type: integer
        description: Object ID
        name: objId
        in: path
        required: true
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/responses.Response'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/responses.MessageResponse'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/responses.MessageResponse'
definitions:
  models.ExternalIDPatchRequest:
    type: object
    properties:
      external_id:
        type: string
      integration_name:
        type: string
  responses.Response:
    type: object
    properties:
      id:
        type: integer
        example: 73
  responses.MessageResponse:
    type: object
    properties:
      message:
        type: string
        example: some message
  models.ExternalIDResponse:
    type: object
    properties:
      added:
        description: Unix timestamp
        type: integer
        example: 1595230999
      addedby_id:
        description: user ID
        type: integer
        example: 1
      changed:
        description: Unix timestamp
        type: integer
        example: 1595230999
      changedby_id:
        description: user ID
        type: integer
        example: 1
      entityName:
        type: string
      external_id:
        type: string
      integration_name:
        type: string
      obj_id:
        type: integer
securityDefinitions:
  AccessToken:
    type: apiKey
    name: accessToken
    in: header
  ErplyClientCode:
    type: apiKey
    name: clientCode
    in: header
  ErplyJWT:
    type: apiKey
    name: jwt
    in: header
  ErplySession:
    type: apiKey
    name: sessionKey
    in: header
  RequestKey:
    type: apiKey
    name: requestKey
    in: header