HTTP status code 200

Return the customer user related data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "ChangeBy": "1",
  "UserID": "theo",
  "UserPhone": "",
  "UserShowTickets": "25",
  "UserCity": "",
  "TicketListTicketsPerPage": "10",
  "Source": "CustomerUser",
  "MultipleArticlesView": "0",
  "ChangeTime": "2018-02-23 08:28:32",
  "UserLastname": "Test",
  "UserAvatar": "image content...",
  "UserMailString": "\"Theo Test\" <theo@example.com>",
  "TicketListOrderBy": "Down",
  "UserMobile": "",
  "CreateTime": "2018-02-23 08:28:32",
  "UserFax": "",
  "UserFullname": "Theo Test",
  "UserZip": "",
  "ValidID": "1",
  "UserStreet": "",
  "CustomerCompanyValidID": null,
  "UserComment": "",
  "UserLogin": "theo",
  "UserLoginFailed": "0",
  "UserEmail": "theo@example.com",
  "UserLastLoginTimestamp": "2018-04-06 12:56:38",
  "UserCustomerID": "example.com",
  "UserTitle": "",
  "CreateBy": "1",
  "UserRefreshTime": "0",
  "UserCountry": "",
  "TicketListSortBy": "Created",
  "UserFirstname": "Theo",
  "UserLastLogin": "1523019398"
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the data was successfully saved

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Indicates that was some problem while validating the data

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Password": {
      "Data": [
        "8"
      ],
      "Message": "Password must have at least %d character(s)."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to save the user preference setting.",
    "ErrorIdentifier": "CouldNotSaveUserPreference"
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Password recovery instructions were sent via email.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "EmailSendingFailed",
    "ErrorMessage": "Could not send password recovery instructions via email. Please contact the administrator."
  },
  {
    "ErrorMessage": "Multiple accounts with the same email address were found. Please contact the administrator.",
    "ErrorIdentifier": "MultipleAccountsFound"
  }
]

HTTP status code 200

Register a new customer user account.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "UserLogin": "customer@test.com"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "Could not add new customer user.",
    "ErrorIdentifier": "AddingCustomerFailed"
  },
  {
    "ErrorIdentifier": "EmailAddressAlreadyExists",
    "ErrorMessage": "This e-mail address already exists. Please log in or reset your password."
  },
  {
    "ErrorIdentifier": "EmailAddressBlacklisted",
    "ErrorMessage": "This email address is not allowed to register. Please contact support staff."
  },
  {
    "ErrorMessage": "Could not send email with new customer user account information.",
    "ErrorIdentifier": "EmailSendingFailed"
  }
]

HTTP status code 200

Password was successfully reset and sent to the account email address.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "EmailSendingFailed",
    "ErrorMessage": "Could not send new password via email. Please contact the administrator."
  },
  {
    "ErrorIdentifier": "PasswordResetFailed",
    "ErrorMessage": "Reset password was unsuccessful. Please contact the administrator."
  },
  {
    "ErrorMessage": "Supplied password reset token is invalid. Please check your link.",
    "ErrorIdentifier": "PasswordResetTokenInvalid"
  }
]

HTTP status code 200

Authentication token is valid.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 401

Authentication token is invalid.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Success response, will create or clear the access token cookie.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 200

Return access token after successful login.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Token": "eyJhbGciOiJIUzI1NiJeyJhdWQiOiJjdXN0b21lc"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to generate the token.",
    "ErrorIdentifier": "CouldNotGenerateToken"
  },
  {
    "ErrorIdentifier": "SessionLimitPerUserReached",
    "ErrorMessage": "Session per user limit reached!"
  },
  {
    "ErrorIdentifier": "SessionLimitReached",
    "ErrorMessage": "Session limit reached! Please try again later."
  }
]

HTTP status code 200

Logged out successfully.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 200

Returns a list of personal notifications.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "List": [
    {
      "Marker": {
        "NotificationID": 123,
        "Status": "Unread"
      },
      "Content": {
        "Description": "some description",
        "UserID": 123,
        "TicketNumber": "123456",
        "UserType": "Customer",
        "Seen": 0,
        "CreateTime": "2018-08-27 14:24:20",
        "ObjectReference": "54321",
        "Body": "some body",
        "Comment": "",
        "Title": "some title",
        "ObjectType": "Ticket",
        "ObjectID": 123,
        "NotificationID": "68"
      }
    }
  ],
  "TotalNotifications": 1
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Seen flag was set.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Created the ticket successfully.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "NextScreenAfterNewTicket": "TicketOverview",
  "TicketNumber": "2018061740123"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to create the article.",
    "ErrorIdentifier": "CouldNotCreateArticle"
  },
  {
    "ErrorIdentifier": "CouldNotCreateTicket",
    "ErrorMessage": "The system was unable to create the ticket."
  },
  {
    "ErrorIdentifier": "CouldNotSetDynamicField",
    "ErrorMessage": "The system was unable to set a dynamic field value."
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Return the ticket count.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Company tickets requested, but company tickets are disabled.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "ArticleLoadingFailed",
    "ErrorMessage": "The system was unable to load the articles."
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Return the ticket list.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "TotalTickets": 1,
  "List": [
    {
      "DynamicField_Checkbox": {
        "TranslatableValues": 1,
        "Value": ""
      },
      "Marker": "Unread",
      "Queue": "Misc",
      "ResponsibleID": 1,
      "Type": "Unclassified",
      "QueueID": 4,
      "EscalationResponseTime": 0,
      "CreateBy": 1,
      "OwnerID": 1,
      "Created": "2018-08-13 07:28:21",
      "GroupID": 1,
      "UntilTime": 0,
      "RealTillTimeNotUsed": 0,
      "StateType": "new",
      "PriorityID": 3,
      "CustomerID": "customer-1",
      "Lock": "unlock",
      "TypeID": 1,
      "StateID": 1,
      "Owner": "root@localhost",
      "Age": 97123,
      "State": "new",
      "EscalationTime": 0,
      "CustomerUserID": "customer-1",
      "EscalationUpdateTime": 0,
      "CreatedByUser": "John Doe",
      "TicketNumber": "2018081354000023",
      "UnlockTimeout": 0,
      "Changed": "2018-08-13 07:28:21",
      "Title": "Ticket #2",
      "EscalationSolutionTime": 0,
      "ServiceID": "",
      "TicketID": 13,
      "ArchiveFlag": "n",
      "Responsible": "root@localhost",
      "Priority": "3 normal",
      "LockID": 1,
      "SLAID": "",
      "ChangeBy": 1
    }
  ]
}

HTTP status code 404

Company tickets requested, but company tickets are disabled.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "ArticleLoadingFailed",
    "ErrorMessage": "The system was unable to load the articles."
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Successfully saved.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Access denied.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

No activity found to the current ticket state.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid ticket data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field2": {
      "Attributes": {
        "Arguments": null,
        "Value": null,
        "Source": null
      },
      "Validator": "Required"
    },
    "Field3": {
      "Validator": "IncorrectDisplayConfig"
    },
    "Field1": {
      "Attributes": {
        "Arguments": null,
        "Value": null,
        "Source": null
      },
      "Validator": "Required"
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to create the ticket.",
    "ErrorIdentifier": "CouldNotCreateTicket"
  },
  {
    "ErrorIdentifier": "CouldNotCreateTicketArticle",
    "ErrorMessage": "The system was unable to create the ticket article."
  },
  {
    "ErrorMessage": "The system was unable to prepare the data to store it.",
    "ErrorIdentifier": "CouldNotPrepareData"
  },
  {
    "ErrorMessage": "The system was unable to set dynamic ticket data.",
    "ErrorIdentifier": "CouldNotSetDynamicFieldValue"
  },
  {
    "ErrorMessage": "The system was unable to set the ticket process state.",
    "ErrorIdentifier": "CouldNotSetTicketProcessState"
  },
  {
    "ErrorIdentifier": "CouldNotUpdateTicket",
    "ErrorMessage": "The system was unable to update ticket information."
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the article was successfully create

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "ArticleID": 123,
  "NextScreenAfterFollowUp": "TicketOverview"
}

HTTP status code 403

Indicates that it's not possible to reopen the given ticket or the user hasn't access to the the ticket.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Error": "Can't reopen ticket, not possible in this queue!"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to create the article.",
    "ErrorIdentifier": "CouldNotCreateArticle"
  },
  {
    "ErrorMessage": "The system was unable to set a dynamic field value.",
    "ErrorIdentifier": "CouldNotSetDynamicField"
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "ArticleLoadingFailed",
    "ErrorMessage": "The system was unable to load the articles."
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the attachment was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Indicates that the access to the attachment is denied (No access to the ticket or the article is not visible).

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Indicates that the attachment was not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the attachment was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Indicates that the access to the attachment is denied (No access to the ticket or the article is not visible).

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Indicates that the attachment was not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the attachment was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Indicates that the access to the attachment is denied (No access to the ticket or the article is not visible).

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Indicates that the attachment was not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that the attachment was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Indicates that the access to the attachment is denied (No access to the ticket or the article is not visible).

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Indicates that the attachment was not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Return article body.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: text/html

Type: object

Example:

<pre>Some example article body!</pre>

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Article flag set successfully

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Successfully saved.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 403

Access denied.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

No activity found to the current ticket state.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid ticket data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Validator": "Required",
      "Attributes": {
        "Value": null,
        "Source": null,
        "Arguments": null
      }
    },
    "Field3": {
      "Validator": "IncorrectDisplayConfig"
    },
    "Field2": {
      "Validator": "Required",
      "Attributes": {
        "Arguments": null,
        "Value": null,
        "Source": null
      }
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "CouldNotCreateTicket",
    "ErrorMessage": "The system was unable to create the ticket."
  },
  {
    "ErrorMessage": "The system was unable to create the ticket article.",
    "ErrorIdentifier": "CouldNotCreateTicketArticle"
  },
  {
    "ErrorMessage": "The system was unable to prepare the data to store it.",
    "ErrorIdentifier": "CouldNotPrepareData"
  },
  {
    "ErrorMessage": "The system was unable to set dynamic ticket data.",
    "ErrorIdentifier": "CouldNotSetDynamicFieldValue"
  },
  {
    "ErrorIdentifier": "CouldNotSetTicketProcessState",
    "ErrorMessage": "The system was unable to set the ticket process state."
  },
  {
    "ErrorMessage": "The system was unable to update ticket information.",
    "ErrorIdentifier": "CouldNotUpdateTicket"
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Deleted the attachment successfully.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 404

Attachment not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to delete the attachment from the upload cache.",
    "ErrorIdentifier": "CouldNotDeleteFile"
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Returning the related attachment.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/octet-stream

Type: object

Example:

Some file content

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Attachment successfully saved.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "FileID": 1,
  "uploaded": 1,
  "url": "/api/customer/upload/bbcbda800-31f3-11e8-a39e-6ba2f50ba514%40localhost"
}

HTTP status code 413

The attachment is too big to be uploaded.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Upload": {
      "Message": "Size limit exceeded!"
    }
  }
}

HTTP status code 422

Invalid upload or UploadFile!

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Upload": {
      "Message": "Invalid upload or UploadFile!"
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorMessage": "The system was unable to add the attachment in the upload cache.",
    "ErrorIdentifier": "CouldNotAddFile"
  }
]

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Return configuration entries.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "WebApp::API::Customer::Account::Recover": "1",
  "WebApp::API::Customer::Account::Register": "1"
}

HTTP status code 200

Get custom page content.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Content": "content"
}

HTTP status code 404

Custom page was not found.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Get custom page inline image

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Content": "content"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Returns the form schema.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 200

Returns the form schema.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 200

Returns the form schema.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 200

Returns personal preferences form schema.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Schema": {
    "Fields": [
      {
        "Label": "Label",
        "Description": "Description of the field"
      }
    ]
  }
}

HTTP status code 422

Indicates that the given category or some fields are invalid.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "FieldName": {
      "Data": {
        "SomeField": 1
      },
      "Message": "Some error message"
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Returns form schemata.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Returns form schemata for process ticket.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Returns form schemata for process ticket.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Schema": {
    "Fields": [
      {
        "Label": "Label",
        "Description": "Description of the field"
      }
    ]
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Returns form schemata for process ticket.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

Return home page configuration.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "ChangeTime": "2018-08-14 22:45:00",
  "ChangeBy": 1,
  "CreateTime": "2018-08-14 22:45:00",
  "CreateBy": 1,
  "Key": "HomePage::de",
  "Value": {
    "TicketList": {
      "RowTitle": "Titel",
      "Show": "1"
    },
    "HeroUnit": {
      "Title": "Titel",
      "BackgroundStyle": "BackgroundO{ydient",
      "BackgroundImage": "path",
      "BackgroundColor": "#111"
    }
  }
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Requested home page image in binary format.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

(image binary data)

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Requested favorites icon in binary format.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

(image binary data)

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Requested layout image in binary format.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

(image binary data)

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Return the navigation structure.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Top": [
    {
      "Prio": "100",
      "Name": "Custom Link",
      "ExternalLink": "",
      "Target": "",
      "IsPublic": "1",
      "RouteLink": "/home",
      "Description": "Custom link.",
      "GroupRo": [],
      "Group": []
    }
  ],
  "Main": [
    {
      "IsPublic": "1",
      "Target": "",
      "RouteLink": "/knowledge-base",
      "Description": "Knowledge base.",
      "Group": [],
      "GroupRo": [],
      "ExternalLink": "",
      "Name": "Knowledge Base",
      "Prio": "100"
    },
    {
      "GroupRo": [],
      "Group": [],
      "Description": "This is a private resource.",
      "RouteLink": "/private-resource",
      "Target": "",
      "IsPublic": "",
      "Prio": "100",
      "Name": "Private Resource",
      "ExternalLink": ""
    }
  ],
  "Bottom": [
    {
      "Name": "Knowledge Base",
      "Prio": "100",
      "ExternalLink": "",
      "GroupRo": [],
      "Group": [],
      "RouteLink": "/knowledge-base",
      "Description": "Knowledge base.",
      "Target": "",
      "IsPublic": "1"
    }
  ]
}

HTTP status code 200

Indicates that data was successfully returned.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Secured by CustomerAccessToken

Headers

• Authentication: (string)

  Used to send the JSON Web Token. Alternatively, you can send an 'AuthenticationCustomer' cookie header value that contains the token.

  Example:

  Bearer [token]

• Cookie: (string)

  Use this to send the token in browser based contexts where custom HTTP headers cannot be set. Cookie authentication is only supported by some endpoints that cannot operate with the normal authentication header.

  Example:

  Authentication=[token]

• X-OTRS-API-FakeCustomerLogin: (string)

  Fake customer authentication (works on development server only!)

  Example:

  testuser_login

HTTP status code 401

Bad token.

HTTP status code 403

Access denied.

HTTP status code 200

List of items with their common and localization data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Items": [
    {
      "ItemID": 1,
      "Link": "/home",
      "Description": "Consectetur adipiscing elit, donec id fermentum ligula finibus venenatis dui. Ut eget rutrum eros. Praesent vulputate laoreet tortor. Aliquam in massa vel erat euismod pellentesque. Aenean eget porttitor nisl, non viverra dui. Cras posuere pellentesque metus id gravida. Sed lacinia lacus vitae elementum convallis. Praesent nec rhoncus augue.",
      "Title": "Lorem ipsum dolor sit amet",
      "CategoryID": [
        1
      ]
    }
  ]
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

List of categories and assumed language.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Language": "en",
  "Categories": [
    {
      "CategoryID": "1",
      "Title": "Home"
    },
    {
      "CategoryID": "2",
      "Title": "Product 1",
      "ParentID": "1"
    },
    {
      "Title": "Product 2",
      "CategoryID": "3",
      "ParentID": "1"
    }
  ]
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Common and localization data for a single service catalogue item.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "CategoryIDs": [
    1
  ],
  "Description": "Consectetur adipiscing elit, donec id fermentum ligula finibus venenatis dui. Ut eget rutrum eros. Praesent vulputate laoreet tortor. Aliquam in massa vel erat euismod pellentesque. Aenean eget porttitor nisl, non viverra dui. Cras posuere pellentesque metus id gravida. Sed lacinia lacus vitae elementum convallis. Praesent nec rhoncus augue.",
  "ItemID": 1,
  "Link": "/home",
  "Title": "Lorem ipsum dolor sit amet"
}

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 200

Item usage counter has been increased successfully.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

HTTP status code 422

Invalid input data.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

{
  "Errors": {
    "Field1": {
      "Message": "..."
    }
  }
}

HTTP status code 900

Custom error response, see example for a list of possible responses.

Headers

• X-OTRS-API-Debug-SQLTrace: (string)

  Includes SQL debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_sql_trace' is enabled.

• X-OTRS-API-Debug-STDERRLog: (string)

  Includes STDERR debugging information, if 'X-OTRS-API-Debug' was sent and 'enable_debugger_stderr_log' is enabled.

• X-OTRS-API-Version: required (string)

  Provides endpoint version information.

  Example:

  1.0.0

Body

Media type: application/json

Type: object

Example:

[
  {
    "ErrorIdentifier": "UsageCounterIncreaseFailed",
    "ErrorMessage": "Increase of the service usage counter failed. Please contact the administrator."
  }
]