Create new Extra Value
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new Extra Value

  • Dark
    Light
  • PDF

Article summary

Post
/extra-values/

Operation is used to create new extra value. Available from product version 3.0.24.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Extra Value to be created

object
extraAttribute
integer Required

Extra Attribute id

extraValue
string Required

Value of Attribute. Format is defined by related Extra Attribute data type

relatedInstanceId
integer Required

Id of related object instance

Responses
201

A created Extra Value

object
created
string (date-time)

Creation date and time

extraAttribute
integer

Extra Attribute id

extraValue
string

Value of Attribute. Format is defined by related Extra Attribute data type

id
integer

Unique id of Extra Value

modified
string (date-time)

Creation date and time

relatedInstanceId
integer

Id of related object instance

relatedInstanceUrl
string (url)

Url of related object instance in the API

400

There was an error in request. Usually field validation failed.

{
  "extraAttribute": [
    "This field is required."
  ],
  "extraValue": [
    "This field is required."
  ],
  "relatedInstanceId": [
    "This field is required."
  ]
}
object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error


Was this article helpful?