Event Metadata

For information on installing and using the SDK, please begin by reading the getting started guide.

Get All Event Metadata for Provider

This method returns a list of all event metadata for a given provider.

Method

getAllEventMetadataForProvider(providerId) ⇒ Promise.<object>
Copied to your clipboard
getAllEventMetadataForProvider(providerId) ⇒ Promise.<object>

Parameter	Type	Description
`providerId`	string	The ID that uniquely identifies the provider whose event metadata is to be fetched.

Sample Response

{ "_links":
        { "self":
            {
                "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata"
            }
        },
        "_embedded":
        {
            "event_metadata":  [
                {  "_links": {
                    "rel:sample_event": {
                         "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code-1>/sample_event"
                    },
                     "rel:update": {
                        "href": "https://api.adobe.io/events/<consumerId>/<projectId>/<workspaceId>/providers/<provider-id>/eventmetadata/<event-code-1>"
                    },
                    "self": {
                        "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code-1>"
                    }
                 },
                "description": "<description>",
                "label": "<label>",
                "event_code": "<event-code-1>",
            },
            ...
         ]
    }
}
Copied to your clipboard
{ "_links":
        { "self":
            {
                "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata"
            }
        },
        "_embedded":
        {
            "event_metadata":  [
                {  "_links": {
                    "rel:sample_event": {
                         "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code-1>/sample_event"
                    },
                     "rel:update": {
                        "href": "https://api.adobe.io/events/<consumerId>/<projectId>/<workspaceId>/providers/<provider-id>/eventmetadata/<event-code-1>"
                    },
                    "self": {
                        "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code-1>"
                    }
                 },
                "description": "<description>",
                "label": "<label>",
                "event_code": "<event-code-1>",
            },
            ...
         ]
    }
}

Get Event Metadata for Given Provider and Event Code

You can return metadata for a single event by providing a provider ID and an event code.

Method

getEventMetadataForProvider(providerId, eventCode) ⇒ Promise.<object>
Copied to your clipboard
getEventMetadataForProvider(providerId, eventCode) ⇒ Promise.<object>

Parameter	Type	Description
`providerId`	string	The ID that uniquely identifies the provider whose event metadata is to be fetched.
`eventCode`	string	The specific event code for which the details of the event metadata is to be fetched.

Sample Response

{
  "_links": {
    "rel:sample_event": {
      "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code>/sample_event"
    },
    "rel:update": {
      "href": "https://api.adobe.io/events/<consumerId>/<projectId>/<workspaceId>/providers/<provider-id>/eventmetadata/<event-code>"
    },
    "self": {
      "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code>"
    }
  },
  "description": "<description>",
  "label": "<label>",
  "event_code": "<event-code>"
}
Copied to your clipboard
{
  "_links": {
    "rel:sample_event": {
      "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code>/sample_event"
    },
    "rel:update": {
      "href": "https://api.adobe.io/events/<consumerId>/<projectId>/<workspaceId>/providers/<provider-id>/eventmetadata/<event-code>"
    },
    "self": {
      "href": "https://api.adobe.io/events/providers/<provider-id>/eventmetadata/<event-code>"
    }
  },
  "description": "<description>",
  "label": "<label>",
  "event_code": "<event-code>"
}

Create Event Metadata for a Provider

This function is used to add various event types for a provider.

Method

createEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, body) ⇒ Promise.<object>
Copied to your clipboard
createEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, body) ⇒ Promise.<object>

Parameter	Type	Description
`consumerOrgId`	string	Consumer Organization ID from Adobe Developer Console.
`projectId`	string	Project ID from Adobe Developer Console.
`workspaceId`	string	Workspace ID from Adobe Developer Console.
`providerId`	string	Provider ID for which the event metadata is to be added.
body	object	JSON data that describes the event metadata.

Sample Creation Request Body

{
    "label": "test-label",
    "description": "Test for SDK 1",
    "event_code": "event_code_1"
}
Copied to your clipboard
{
    "label": "test-label",
    "description": "Test for SDK 1",
    "event_code": "event_code_1"
}

Update Event Metadata for a Provider

You can update the description and label of the event metadata by providing the event code of the event metadata to be updated.

Method

updateEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, eventCode, body) ⇒ Promise.<object>
Copied to your clipboard
updateEventMetadataForProvider(consumerOrgId, projectId, workspaceId, providerId, eventCode, body) ⇒ Promise.<object>

Parameter	Type	Description
`consumerOrgId`	string	Consumer Organization ID from Adobe Developer Console.
`projectId`	string	Project ID from Adobe Developer Console.
`workspaceId`	string	Workspace ID from Adobe Developer Console.
`providerId`	string	Provider ID for which the event metadata is to be added.
`eventCode`	string	Event Code of the event metadata to be updated.
body	object	JSON data that describes the updated event metadata.

Sample Update Request Body

{
    "label": "new-label",
    "description": "Updated description for SDK 1",
    "event_code": "event_code_1"
}
Copied to your clipboard
{
    "label": "new-label",
    "description": "Updated description for SDK 1",
    "event_code": "event_code_1"
}

Delete Event Metadata

You can delete metadata for a specific event by providing the event code along with the associated provider ID.

Method

deleteEventMetadata(consumerOrgId, projectId, workspaceId, providerId, eventCode) ⇒ Promise
Copied to your clipboard
deleteEventMetadata(consumerOrgId, projectId, workspaceId, providerId, eventCode) ⇒ Promise

Parameter	Type	Description
`consumerOrgId`	string	Consumer Organization ID from Adobe Developer Console.
`projectId`	string	Project ID from Adobe Developer Console.
`workspaceId`	string	Workspace ID from Adobe Developer Console.
`providerId`	string	Provider ID for which the event metadata is to be deleted.
`eventCode`	string	Event Code of the event metadata to be deleted.

Response

Returns HTTP Status 204 (No Content) once the deletion is successful. If the eventCode or providerId does not exist, HTTP Status 404 (Not Found) is returned.

Delete All Event Metadata

You can delete all event metadata for a provider by specifying a provider ID.

Method

deleteAllEventMetadata(consumerOrgId, projectId, workspaceId, providerId) ⇒ Promise
Copied to your clipboard
deleteAllEventMetadata(consumerOrgId, projectId, workspaceId, providerId) ⇒ Promise

Parameter	Type	Description
`consumerOrgId`	string	Consumer Organization ID from Adobe Developer Console.
`projectId`	string	Project ID from Adobe Developer Console.
`workspaceId`	string	Workspace ID from Adobe Developer Console.
`providerId`	string	Provider ID for which the event metadata is to be deleted.

Response

Returns HTTP Status 204 (No Content) once the deletion is successful. If the providerId does not exist, HTTP Status 404 (Not Found) is returned.

Getting started with Events SDK

Journaling

Last updated 9/9/2021

Was this helpful?

Yes

Event Metadata

Get All Event Metadata for Provider.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Method.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Sample Response

Get Event Metadata for Given Provider and Event Code

Method

Sample Response

Create Event Metadata for a Provider

Method

Sample Creation Request Body

Update Event Metadata for a Provider

Method

Sample Update Request Body

Delete Event Metadata

Method

Response

Delete All Event Metadata

Method

Response

Get All Event Metadata for Provider

Method