Skip to content

segmentdefinition.schema.md

Latest commit

 

History

History
372 lines (204 loc) · 8.99 KB

segmentdefinition.schema.md

File metadata and controls

372 lines (204 loc) · 8.99 KB

Segment definition Schema

https://ns.adobe.com/xdm/context/segmentdefinition

This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted classes/segmentdefinition.schema.json

Schema Hierarchy

Segment definition Example

{
  "xdm:identityMap": {
    "AAMSegments": [
      {
        "xdm:id": "112233",
        "xdm:primary": true
      }
    ]
  },
  "xdm:segmentIdentity": {
    "@id": "seg-id"
  },
  "xdm:labels": [
    "core/C3",
    "custom/mylabel2"
  ],
  "xdm:segmentName": "Users with TV segment",
  "xdm:description": "Segment is about users who have TV",
  "xdm:segmentStatus": "ACTIVE",
  "repo:createDate": "2018-10-23T12:00:00-06:00",
  "repo:modifyDate": "2019-03-21T12:00:00-06:00"
}

Segment definition Properties

Property Type Required Defined by
@id string Optional Record Schema
repo:createDate string Optional Audit trail
repo:modifyDate string Optional Audit trail
xdm:createdByBatchID string Optional Audit trail
xdm:description string Optional Segment definition (this schema)
xdm:identityMap object Optional IdentityMap
xdm:labels string[] Optional Segment definition (this schema)
xdm:modifiedByBatchID string Optional Audit trail
xdm:repositoryCreatedBy string Optional Audit trail
xdm:repositoryLastModifiedBy string Optional Audit trail
xdm:segmentIdentity Segment identity Optional Segment definition (this schema)
xdm:segmentName string Required Segment definition (this schema)
xdm:segmentStatus enum Optional Segment definition (this schema)
xdm:version string Optional Segment definition (this schema)
* any Additional this schema allows additional properties

@id

Identifier

A unique identifier for the record.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

repo:createDate Type

string

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:modifyDate

The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:modifyDate

repo:modifyDate Type

string

repo:modifyDate Example

"2004-10-23T12:00:00-06:00"

xdm:createdByBatchID

Created by batch identifier

The dataset files in Catalog which has been originating the creation of the record.

xdm:createdByBatchID

xdm:createdByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:description

Segment description

Description of the segment.

xdm:description

  • is optional
  • type: string
  • defined in this schema

xdm:description Type

string

xdm:identityMap

xdm:identityMap

xdm:identityMap Type

object with following properties:

Property Type Required

xdm:labels

Labels

When present, it allows an array of labels. Values are resources IDs

xdm:labels

  • is optional

  • type: string[]

  • defined in this schema

xdm:labels Type

Array type: string[]

All items must be of the type: string

xdm:modifiedByBatchID

Modified by batch identifier

The last dataset files in Catalog which has modified the record. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

xdm:modifiedByBatchID Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

xdm:repositoryCreatedBy

Created by user identifier

User ID of who created the record.

xdm:repositoryCreatedBy

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by user identifier

User ID of who last modified the record. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

xdm:repositoryLastModifiedBy Type

string

xdm:segmentIdentity

Segment identity

Identity of the segment.

xdm:segmentIdentity

  • is optional
  • type: Segment identity
  • defined in this schema

xdm:segmentIdentity Type

xdm:segmentName

Segment name

Name of the segment.

xdm:segmentName

  • is required
  • type: string
  • defined in this schema

xdm:segmentName Type

string

xdm:segmentStatus

Segment status

Current status of segment from external system normalized to active, inactive, deleted, draft or revoked.

xdm:segmentStatus

  • is optional
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

xdm:segmentStatus Known Values

Value Description
ACTIVE Active
INACTIVE Inactive
DELETED Deleted
DRAFT Draft
REVOKED Revoked

xdm:version

Segment version

Version of the segment.

xdm:version

  • is optional
  • type: string
  • defined in this schema

xdm:version Type

string