Post a strand attachment event.

POST

experimental

component

{id}

discriminator_events

Post a strand attachment event.

curl --request POST \
  --url https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "target": {
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ancestors": [
      {
        "coordinates": {}
      }
    ],
    "coordinates": {}
  },
  "note": "<string>",
  "effectiveSinceCommitSha": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events"

payload = {
    "target": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ancestors": [{ "coordinates": {} }],
        "coordinates": {}
    },
    "note": "<string>",
    "effectiveSinceCommitSha": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    target: {
      componentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      ancestors: [{coordinates: {}}],
      coordinates: {}
    },
    note: '<string>',
    effectiveSinceCommitSha: '<string>'
  })
};

fetch('https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => [
        'componentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'ancestors' => [
                [
                                'coordinates' => [
                                                                
                                ]
                ]
        ],
        'coordinates' => [
                
        ]
    ],
    'note' => '<string>',
    'effectiveSinceCommitSha' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events"

	payload := strings.NewReader("{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "STRAND_PAYLOAD_ADDED"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Path Parameters

string<uuid>

required

UUID of the component the event targets.

Body

application/json

A single coordinate-addressed attachment event. The target is the full canonical group address the event attaches to; its level must match the event type (payload events target a payload, field-mapping events target a field_mapping). declaredBoundaryPair is only valid on STRAND_PAYLOAD_ADDED.

eventType

enum<string>

required

Public event vocabulary for coordinate-addressed strand attachments. ADD/DELETE are BYO group declarations for payloads and field mappings — a declared payload absent from the scan becomes a v2-only payload group its declared field mappings can attach to; SUPPRESS/UNSUPPRESS toggle a suppression for a field mapping or payload.

Available options:

STRAND_PAYLOAD_ADDED,

STRAND_PAYLOAD_DELETED,

STRAND_FIELD_MAPPING_ADDED,

STRAND_FIELD_MAPPING_DELETED,

STRAND_FIELD_MAPPING_SUPPRESSED,

STRAND_FIELD_MAPPING_UNSUPPRESSED,

STRAND_PAYLOAD_SUPPRESSED,

STRAND_PAYLOAD_UNSUPPRESSED

target

object

required

The metadata coordinates for a discriminator group

Show child attributes

declaredBoundaryPair

object

The ingress → egress boundary pair a declared payload runs between, named in the same vocabulary as DiscriminatorBoundary.name. Valid only on STRAND_PAYLOAD_ADDED. A payload declared without a scan has no roll-up provenance, so this pair is the only source of its boundaries: the read reports it as the payload's boundary pair, and every consumer of boundary pairs (payload display, graph boundaries, boundary fields, edge endpoint display) treats the payload like a scanned one. It is never part of the group address, so it never affects coordinates or the derived group id, and a scan that later produces the same address supersedes it with the roll-up's own pairs.

Show child attributes

note

string

Optional free-text audit note

effectiveSinceCommitSha

string

Full lowercase commit SHA the attachment is effective since; it must be a commit the component has a scan for. When omitted, defaults to the latest scan's commit. The event applies only to versions whose commit is at or after this anchor.

Pattern: ^[0-9a-f]{40}(?:[0-9a-f]{24})?$

Response

Event accepted; receipt returned.

Returned data for a BYO discriminator event.

eventId

string<uuid>

required

eventType

enum<string>

required

Available options:

STRAND_PAYLOAD_ADDED,

STRAND_PAYLOAD_DELETED,

STRAND_FIELD_MAPPING_ADDED,

STRAND_FIELD_MAPPING_DELETED,

STRAND_FIELD_MAPPING_SUPPRESSED,

STRAND_FIELD_MAPPING_UNSUPPRESSED,

STRAND_PAYLOAD_SUPPRESSED,

STRAND_PAYLOAD_UNSUPPRESSED

⌘I

Post a strand attachment event.

curl --request POST \
  --url https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "target": {
    "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ancestors": [
      {
        "coordinates": {}
      }
    ],
    "coordinates": {}
  },
  "note": "<string>",
  "effectiveSinceCommitSha": "<string>"
}
'

import requests

url = "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events"

payload = {
    "target": {
        "componentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ancestors": [{ "coordinates": {} }],
        "coordinates": {}
    },
    "note": "<string>",
    "effectiveSinceCommitSha": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    target: {
      componentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      ancestors: [{coordinates: {}}],
      coordinates: {}
    },
    note: '<string>',
    effectiveSinceCommitSha: '<string>'
  })
};

fetch('https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => [
        'componentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'ancestors' => [
                [
                                'coordinates' => [
                                                                
                                ]
                ]
        ],
        'coordinates' => [
                
        ]
    ],
    'note' => '<string>',
    'effectiveSinceCommitSha' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events"

	payload := strings.NewReader("{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{hostname}.gable.ai/v0/experimental/component/{id}/discriminator_events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": {\n    \"componentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ancestors\": [\n      {\n        \"coordinates\": {}\n      }\n    ],\n    \"coordinates\": {}\n  },\n  \"note\": \"<string>\",\n  \"effectiveSinceCommitSha\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "eventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "eventType": "STRAND_PAYLOAD_ADDED"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Introduction

Gable

Post a strand attachment event.

Authorizations

Path Parameters

Body

Response