Erply clsf-labels API
The clsf-labels API from Erply — 4 operation(s) for clsf-labels.
OpenAPI Specification
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 clsf-labels API
contact: {}
version: 2.36.5
host: ''
basePath: ''
schemes: []
tags:
- name: clsf-labels
paths:
/api/v1/clsf/label:
get:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Look up labels
parameters:
- type: string
description: Object type for which labels should be returned. One of [workorder raji]
name: entity
in: query
required: true
- type: string
description: Label type code for which labels should be returned
name: labelType
in: query
- type: array
items:
type: integer
collectionFormat: csv
description: Label ids
name: ids
in: query
- type: string
description: Language to use when sorting by name (`en`, `et`, `ru` etc.)
name: lang
in: query
- type: string
description: Label code to search for. Partial matching from the beginning of the code
name: code
in: query
- type: integer
description: Result page size
name: pageSize
in: query
- type: integer
description: Result page number
name: pageNr
in: query
- type: string
description: 'Sorting order. Supported values are: `id`, `name`. Defaults to `id`'
name: sort
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/ClsfResponse'
'401':
description: Forbidden
'500':
description: Internal Server Error
post:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Add a new label record
parameters:
- description: Label record
name: record
in: body
required: true
schema:
$ref: '#/definitions/ClsfLabelRequest'
responses:
'201':
description: OK
schema:
$ref: '#/definitions/ClsfResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'500':
description: Internal Server Error
/api/v1/clsf/label-type:
get:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Look up label types
parameters:
- type: array
items:
type: integer
collectionFormat: csv
description: Label type ids
name: ids
in: query
- type: string
description: Object type for which label types should be returned. One of [workorder raji]
name: entity
in: query
required: true
- type: string
description: Language to use when sorting by name (`en`, `et`, `ru` etc.)
name: lang
in: query
- type: string
description: Label type code to search for. Partial matching from the beginning of the code
name: code
in: query
- type: integer
description: Result page size
name: pageSize
in: query
- type: integer
description: Result page number
name: pageNr
in: query
- type: string
description: 'Sorting order. Supported values are: `id`, `name`. Defaults to `id`'
name: sort
in: query
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/ClsfResponse'
'401':
description: Forbidden
'500':
description: Internal Server Error
post:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Add a new label type
parameters:
- description: Clsf record
name: record
in: body
required: true
schema:
$ref: '#/definitions/ClsfLabelTypeRequest'
responses:
'201':
description: OK
schema:
$ref: '#/definitions/ClsfResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'500':
description: Internal Server Error
/api/v1/clsf/label-type/{typeId}:
delete:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Delete one label type record
parameters:
- type: integer
description: Record id
name: typeId
in: path
required: true
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
patch:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Update an existing label type record
parameters:
- type: integer
description: Record id
name: typeId
in: path
required: true
- description: Clsf record
name: record
in: body
required: true
schema:
$ref: '#/definitions/ClsfLabelTypeRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClsfResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
/api/v1/clsf/label/{labelId}:
delete:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Delete one label record
parameters:
- type: integer
description: Record id
name: labelId
in: path
required: true
responses:
'200':
description: OK
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
patch:
security:
- ErplyClientCode: []
- ErplySession: []
- ErplyJWT: []
consumes:
- application/json
produces:
- application/json
tags:
- clsf-labels
summary: Update an existing label record
parameters:
- type: integer
description: Record id
name: labelId
in: path
required: true
- description: Clsf record
name: record
in: body
required: true
schema:
$ref: '#/definitions/ClsfLabelRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ClsfResponse'
'400':
description: Bad Request
'401':
description: Forbidden
'404':
description: Not Found
'500':
description: Internal Server Error
definitions:
ClsfResponse:
type: object
properties:
children:
type: array
items:
$ref: '#/definitions/ClsfChildResponse'
code:
type: string
createdAt:
type: string
createdById:
type: integer
entity:
type: string
id:
type: integer
name:
$ref: '#/definitions/core.Translatable'
parentId:
type: integer
updatedAt:
type: string
updatedById:
type: integer
ClsfChildResponse:
type: object
properties:
code:
type: string
type:
type: string
ClsfLabelRequest:
type: object
properties:
code:
type: string
entity:
type: string
id:
type: integer
name:
$ref: '#/definitions/core.Translatable'
type:
type: string
ClsfLabelTypeRequest:
type: object
properties:
code:
type: string
entity:
type: string
id:
type: integer
name:
$ref: '#/definitions/core.Translatable'
core.Translatable:
type: object
properties:
ar:
type: string
example: ' '
cs:
type: string
example: ' '
da:
type: string
example: ' '
de:
type: string
example: ' '
default:
type: string
example: ' '
el:
type: string
example: ' '
en:
type: string
example: ' '
es:
type: string
example: ' '
et:
type: string
example: ' '
fi:
type: string
example: ' '
fo:
type: string
example: ' '
fr:
type: string
example: ' '
it:
type: string
example: ' '
lt:
type: string
example: ' '
lv:
type: string
example: ' '
nl:
type: string
example: ' '
'no':
type: string
example: ' '
pl:
type: string
example: ' '
ru:
type: string
example: ' '
sv:
type: string
example: ' '
th:
type: string
example: ' '
tr:
type: string
example: ' '
vi:
type: string
example: ' '
zh_Hans:
type: string
example: ' '
zh_Hant:
type: string
example: ' '
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