Menu

Connection Types

Connections track the relationship between entities. They are a way to link entities like people, places or groups together. Connections can exist between entities of the same type or entities of a different type. Each connection between different types of entity forms a different connection type.

Connection types have two different entity types that form the connection type.

Endpoints and URL Structures


https://[your-sub-domain].actionbuilder.org/api/rest/v1/campaigns/[campaign_id]/connection_types

Connection type resources live exclusively at the above endpoint. The endpoint returns a collection of all the connection types associated with your API key and specified campaign.

URL Structures:


https://[your-sub-domain].actionbuilder.org/api/rest/v1/campaigns/[campaign_id]/connection_types/[connection_type_id]

To address a specific connection type, use the resource type name like:


https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/f2cafa3f-213c-47ab-8188-868c75048f5f
Back To Top ↑

Field Names and Descriptions

Connection Type Fields

Field Name Type Description
origin_system string A human readable string identifying where this connection type originated.
identifiers strings[] An array containing the read-only Action Builder identifier of this resource in the format [system name]:[id]. See the general concepts document for more information about identifiers.
created_date datetime The date and time the resource was created. System generated, not editable.
modified_date datetime The date and time the resource was last modified. System generated, not editable.
connection connection[] An array of the entity types that form this connection.

Connection Fields

Field Name Type Description
connection.types string The plural name of the entity type that forms this connection. Two will always be present.

Back To Top ↑

Scenario: Retrieving a collection of connection type resources (GET)

Connection type resources are sometimes presented as collections of connection types. For example, calling the connection types endpoint will return a collection of all the connection types associated with that API key and specified campaign.

Request

						
GET https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types		

Header:
OSDI-API-Token: your_api_key_here

Response

						
{
  "per_page": 25,
  "page": 1,
  "total_pages": 1,
  "_embedded": {
    "action_builder:connection_types": [
      {
        "origin_system": "Action Builder",
        "identifiers": [
          "action_builder:4e07f3eb-d0e4-4b5b-8bc4-1368af2e535f"
        ],
        "created_date": "2022-01-24T18:58:15.870Z",
        "modified_date": "2022-01-24T18:58:15.870Z",
        "connection": [
          "people",
          "locals"
        ],
        "_links": {
          "self": {
            "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/4e07f3eb-d0e4-4b5b-8bc4-1368af2e535f"
          },
          "action_builder:campaign": {
            "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f"
          },
          "action_builder:entity_types": [
            {
              "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/786888a8-868f-4694-a3ba-1caf0688d0c0"
            },
            {
              "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/fa0016b8-c69e-46e2-bd73-84613adc5d68"
            }
          ]
        }
      },
      {
        "origin_system": "Action Builder",
        "identifiers": [
          "action_builder:f2cafa3f-213c-47ab-8188-868c75048f5f"
        ],
        "created_date": "2020-12-15T19:40:19.212Z",
        "modified_date": "2021-08-12T21:55:13.819Z",
        "connection": [
          "people",
          "people"
        ],
        "_links": {
          "self": {
            "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/f2cafa3f-213c-47ab-8188-868c75048f5f"
          },
          "action_builder:campaign": {
            "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f"
          },
          "action_builder:entity_types": [
            {
              "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/786888a8-868f-4694-a3ba-1caf0688d0c0"
            },
            {
              "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/786888a8-868f-4694-a3ba-1caf0688d0c0"
            }
          ]
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types"
    },
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionbuilder.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_builder",
        "href": "https://actionbuilder.org/docs/v1/{rel}",
        "templated": true
      }
    ],
    "action_builder:connection_types": [
      {
        "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/4e07f3eb-d0e4-4b5b-8bc4-1368af2e535f"
      },
      {
        "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/f2cafa3f-213c-47ab-8188-868c75048f5f"
      }
    ]
  }
}

Back To Top ↑

Scenario: Retrieving an individual connection type resource (GET)

Calling an individual connection type resource will return the connection type directly, along with all associated fields and appropriate links to additional information about the connection type.

Request

					
GET https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/f2cafa3f-213c-47ab-8188-868c75048f5f

Header:
OSDI-API-Token: your_api_key_here

Response

			 	 
200 OK

Content-Type: application/hal+json
Cache-Control: max-age=0, private, must-revalidate					 
					 
{
  "origin_system": "Action Builder",
  "identifiers": [
    "action_builder:f2cafa3f-213c-47ab-8188-868c75048f5f"
  ],
  "created_date": "2020-12-15T19:40:19.212Z",
  "modified_date": "2021-08-12T21:55:13.819Z",
  "connection": [
    "people",
    "people"
  ],
  "_links": {
    "curies": [
      {
        "name": "osdi",
        "href": "https://actionbuilder.org/docs/v1/{rel}",
        "templated": true
      },
      {
        "name": "action_builder",
        "href": "https://actionbuilder.org/docs/v1/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/connection_types/f2cafa3f-213c-47ab-8188-868c75048f5f"
    },
    "action_builder:campaign": {
      "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f"
    },
    "action_builder:entity_types": [
      {
        "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/786888a8-868f-4694-a3ba-1caf0688d0c0"
      },
      {
        "href": "https://techworkersunited.actionbuilder.org/api/rest/v1/campaigns/84a684a7-2f5a-4359-bdb4-898ce4fbc88f/entity_types/786888a8-868f-4694-a3ba-1caf0688d0c0"
      }
    ]
  }
}

Back To Top ↑

Scenario: POST/PUT/DELETE

Posting, putting, and deleting of connection types is not allowed. Attempts will result in errors.


Back To Top ↑