Annotation Labels Partial Update

Options

Id

A unique integer value identifying this Label.

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "name", "slug" ],
  "type" : "object",
  "properties" : {
    "id" : {
      "title" : "ID",
      "type" : "integer",
      "readOnly" : true
    },
    "owner" : {
      "title" : "Owner",
      "type" : "string",
      "readOnly" : true
    },
    "trusted" : {
      "title" : "Trusted",
      "type" : "string",
      "readOnly" : true
    },
    "name" : {
      "title" : "Name",
      "maxLength" : 100,
      "minLength" : 1,
      "type" : "string",
      "description" : "Verbose name, e.g. This Awesome annotation"
    },
    "slug" : {
      "title" : "Slug",
      "maxLength" : 100,
      "pattern" : "^[-a-zA-Z0-9_]+$",
      "type" : "string",
      "description" : "Identifier, e.g. this-awesome-annotation",
      "format" : "slug"
    },
    "private" : {
      "title" : "Private",
      "type" : "boolean",
      "description" : "Private annotations are only visible to its author"
    },
    "many_annotations_per_label" : {
      "title" : "Many annotations per label",
      "type" : "boolean",
      "description" : "A content object can have more than one annotation per label"
    },
    "use_marker" : {
      "title" : "Use marker",
      "type" : "boolean",
      "description" : "Marker annotations are extracted from the text content and have a position in the text"
    },
    "annotation_value_type" : {
      "title" : "Annotation value type",
      "type" : "string",
      "description" : "Annotation values must be in this data type",
      "enum" : [ "str", "int" ]
    },
    "color" : {
      "title" : "Color",
      "maxLength" : 18,
      "minLength" : 1,
      "pattern" : "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
      "type" : "string"
    },
    "created_at" : {
      "title" : "Created at",
      "type" : "string",
      "description" : "Entry is created at this date time",
      "format" : "date-time",
      "readOnly" : true
    },
    "updated_at" : {
      "title" : "Updated at",
      "type" : "string",
      "description" : "Date time of last change",
      "format" : "date-time",
      "readOnly" : true
    }
  }
}

Response Type

Specify the response type. The following response types are available:

• application/json
• application/xml

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Id:
• Owner:
• Trusted:
• Name: Verbose name, e.g. This Awesome annotation
• Slug: Identifier, e.g. this-awesome-annotation
• Private: Private annotations are only visible to its author
• Many Annotations Per Label: A content object can have more than one annotation per label
• Use Marker: Marker annotations are extracted from the text content and have a position in the text
• Annotation Value Type: Annotation values must be in this data type
• Color:
• Created At: Entry is created at this date time
• Updated At: Date time of last change

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers