Jump to

• Request
• Response

Get a child object metadata

get

/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}

Request

Path Parameters

• ObjectCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ObjectCode2(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : objectMetadata-childObjectMetadata-item-response

Type: object

Show Source

• AlternateKeys: string
  Title: Alternate Keys

  Read Only: true

  The alternate key of the child object metadata.
• APPStripe: string
  Title: Application Stripe

  Read Only: true

  Maximum Length: 80

  It specifies the application name of the child object.
• attributes: array Attributes
  Title: Attributes

  The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.
• childObjectMetadata: array Child Object Metadata
  Title: Child Object Metadata

  The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the child object metadata record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the child object metadata record was created.
• Description: string
  Title: Description

  Read Only: true

  The description of the child object metadata.
• DescriptionResourceId: string
  Title: Description Resource ID

  Read Only: true

  The resource identifier of the description of the object.
• DisplayName: string
  Title: Display Name

  Read Only: true

  The display name of the child object metadata.
• DisplayNamePlural: string
  Title: Plural Title

  Read Only: true

  The display name of child object in plural form of the child object metadata.
• ExtensibleViewDefinition: string
  Title: Extensible View Definition

  Read Only: true

  Maximum Length: 600

  The extensible view definition of the child object.
• IsCustomFlag: boolean
  Title: Custom Object

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the child object metadata is custom.
• IsExtensible: string
  Title: Is Extensible

  Read Only: true

  Indicates whether the child object is extensible.
• KeyAttributes: string
  Title: User Keys

  Read Only: true

  The key attributes of the child object metadata.
• LabelResourceId: string
  Title: Label Resource ID

  Read Only: true

  Maximum Length: 700

  The resource identifier of the label of the object.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the child object metadata record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the child object metadata record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Title: Object Name

  Maximum Length: 128

  The language independent code of an child object metadata object, which uniquely identifies the object.
• ObjectDefinition: string
  Title: Object Definition

  Read Only: true

  Maximum Length: 600

  The fully qualified VO name for the child object metadata object.
• objectProperties: array Attribute Properties
  Title: Attribute Properties

  The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.
• ParentObjectCode: string
  Title: Parent Object

  Maximum Length: 128

  The language independent code of the parent object which uniquely identifies the parent object.
• PluralLabelResourceId: string
  Title: Plural Label Resource ID

  Read Only: true

  Maximum Length: 700

  The resource identifier of the name in plural form of the child object.
• PrimaryEntityDefinition: string
  Title: Primary Entity Definition

  Read Only: true

  Maximum Length: 600

  The primary entity definition of the object under ChildObjectMetadata.
• PuidAttribute: string
  Title: Primary Alternate Key

  Read Only: true

  Maximum Length: 100

  The PUID of the child object metadata object.
• relationships: array Relationships
  Title: Relationships

  The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.
• RestResource: string
  Title: REST Resource Code

  Read Only: true

  Maximum Length: 100

  The rest resource name of the child object metadata object.
• RestResourceIdentifier: string
  Title: REST Resource Identifier

  Read Only: true

  Maximum Length: 100

  The unique identifier of the child object metadata rest resource.
• UcmAccount: string
  Title: Account

  Read Only: true

  Maximum Length: 120

  The UCM account of the child object metadata object.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the child object metadata record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateKeys":{
            "title":"Alternate Keys",
            "type":"string",
            "description":"The alternate key of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RestResource":{
            "title":"REST Resource Code",
            "maxLength":"100",
            "type":"string",
            "description":"The rest resource name of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "APPStripe":{
            "title":"Application Stripe",
            "maxLength":"80",
            "type":"string",
            "description":"It specifies the application name of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PluralLabelResourceId":{
            "title":"Plural Label Resource ID",
            "maxLength":"700",
            "type":"string",
            "description":"The resource identifier of the name in plural form of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Name",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of an child object metadata object, which uniquely identifies the object.",
            "nullable":false,
            "x-queryable":true
        },
        "IsCustomFlag":{
            "title":"Custom Object",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the child object metadata is custom.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "DescriptionResourceId":{
            "title":"Description Resource ID",
            "type":"string",
            "description":"The resource identifier of the description of the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryEntityDefinition":{
            "title":"Primary Entity Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The primary entity definition of the object under ChildObjectMetadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-relationships-item-response"
            }
        },
        "RestResourceIdentifier":{
            "title":"REST Resource Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the child object metadata rest resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisplayNamePlural":{
            "title":"Plural Title",
            "type":"string",
            "description":"The display name of child object in plural form of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PuidAttribute":{
            "title":"Primary Alternate Key",
            "maxLength":"100",
            "type":"string",
            "description":"The PUID of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyAttributes":{
            "title":"User Keys",
            "type":"string",
            "description":"The key attributes of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectDefinition":{
            "title":"Object Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The fully qualified VO name for the child object metadata object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "objectProperties":{
            "title":"Attribute Properties",
            "type":"array",
            "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-objectProperties-item-response"
            }
        },
        "UcmAccount":{
            "title":"Account",
            "maxLength":"120",
            "type":"string",
            "description":"The UCM account of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "childObjectMetadata":{
            "title":"Child Object Metadata",
            "type":"array",
            "description":"The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-childObjectMetadata-item-response"
            }
        },
        "ParentObjectCode":{
            "title":"Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the parent object which uniquely identifies the parent object.",
            "nullable":false,
            "x-queryable":true
        },
        "ExtensibleViewDefinition":{
            "title":"Extensible View Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The extensible view definition of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsExtensible":{
            "title":"Is Extensible",
            "type":"string",
            "description":"Indicates whether the child object is extensible.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attributes":{
            "title":"Attributes",
            "type":"array",
            "description":"The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-attributes-item-response"
            }
        },
        "LabelResourceId":{
            "title":"Label Resource ID",
            "maxLength":"700",
            "type":"string",
            "description":"The resource identifier of the label of the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the child object metadata record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attributes

Type: array

Title: Attributes

The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.

Show Source

• Array of: object objectMetadata-childObjectMetadata-attributes-item-response

{
    "title":"Attributes",
    "type":"array",
    "description":"The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-attributes-item-response"
    }
}

Nested Schema : Child Object Metadata

Type: array

Title: Child Object Metadata

The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.

Show Source

• Array of: object objectMetadata-childObjectMetadata-childObjectMetadata-item-response

{
    "title":"Child Object Metadata",
    "type":"array",
    "description":"The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-childObjectMetadata-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Attribute Properties

Type: array

Title: Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Show Source

• Array of: object objectMetadata-childObjectMetadata-objectProperties-item-response

{
    "title":"Attribute Properties",
    "type":"array",
    "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-objectProperties-item-response"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.

Show Source

• Array of: object objectMetadata-childObjectMetadata-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-relationships-item-response"
    }
}

Nested Schema : objectMetadata-childObjectMetadata-attributes-item-response

Type: object

Show Source

• AliasName: string
  Title: Alias Name

  Maximum Length: 300

  The alias name of the corresponding attribute under ObjectMetadata.
• AttrColumn: string
  Title: Column Name

  Maximum Length: 30

  The column of the attribute.
• AttributeCode: string
  Title: Attribute Name

  Maximum Length: 100

  The name of the attribute.
• AttributeDefType: string
  Title: Control Type

  Maximum Length: 50

  The control type of an attribute.
• attributeProperties: array Attribute Properties
  Title: Attribute Properties

  The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.
• AttributeTable: string
  Title: Attribute Table Name

  Maximum Length: 30

  The table associated with the attribute.
• AttributeType: string
  Title: Type

  Maximum Length: 30

  The type of the attribute.
• AttrLength: number
  Title: Length

  The length of the attribute.
• AttrPrecision: number
  Title: Attribute Precision

  The precision of the attribute.
• AttrScale: number
  Title: Attribute Scale

  The scale of the attribute.
• ColumnType: string
  Title: Column Type

  Maximum Length: 30

  The column type of the attribute.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the attributes record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attributes record was created.
• DefaultValue: string
  Title: Default Value

  Maximum Length: 4000

  The default value of the attribute.
• DependsOn: string
  Title: Depends On

  Maximum Length: 800

  The attribute which is used to save the attribute dependencies for the object.
• Description: string
  Title: Description

  Read Only: true

  The description of the attribute.
• DescriptionResourceId: string
  Title: Description Resource ID

  Read Only: true

  The resource identifier of the description of the attribute.
• DisplayName: string
  Title: Display Name

  Read Only: true

  The display name of the attribute.
• EntityUsage: string
  Title: Entity Usage

  Maximum Length: 600

  The entity usage of the corresponding attribute under ObjectMetadata.
• IsCustomFlag: boolean
  Title: Custom Attribute

  Maximum Length: 1

  Default Value: false

  Indicates whether the attribute is custom.
• IsQueryableFlag: boolean
  Title: Searchable

  Read Only: true

  Indicates whether the attribute can be queried.
• IsSQLDerivedExprFlag: boolean
  Title: SQL Derived Expression Flag

  Read Only: true

  Maximum Length: 255

  Indicates whether the attribute is derived from SQL expression.
• IsUpdatableFlag: boolean
  Title: Updatable

  Maximum Length: 1

  Default Value: true

  Indicates whether the attribute is updatable.
• LabelResourceId: string
  Title: Label Resource ID

  Maximum Length: 700

  The resource identifier of the label of the attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attributes record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the attributes record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Required

  Maximum Length: 1

  Default Value: false

  Indicates whether the attribute is mandatory.
• TableName: string
  Title: Object Table Name

  Read Only: true

  The table name of the attribute.
• TransientFlag: boolean
  Title: Transient Flag

  Maximum Length: 1

  Default Value: false

  Indicates whether the attribute is transient attribute or not.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attributes record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransientFlag":{
            "title":"Transient Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute is transient attribute or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnType":{
            "title":"Column Type",
            "maxLength":"30",
            "type":"string",
            "description":"The column type of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeTable":{
            "title":"Attribute Table Name",
            "maxLength":"30",
            "type":"string",
            "description":"The table associated with the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionResourceId":{
            "title":"Description Resource ID",
            "type":"string",
            "description":"The resource identifier of the description of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCustomFlag":{
            "title":"Custom Attribute",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute is custom.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute is mandatory.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The default value of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IsUpdatableFlag":{
            "title":"Updatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute is updatable.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "IsQueryableFlag":{
            "title":"Searchable",
            "type":"boolean",
            "description":"Indicates whether the attribute can be queried.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AliasName":{
            "title":"Alias Name",
            "maxLength":"300",
            "type":"string",
            "description":"The alias name of the corresponding attribute under ObjectMetadata.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attributeProperties":{
            "title":"Attribute Properties",
            "type":"array",
            "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-attributes-attributeProperties-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttrColumn":{
            "title":"Column Name",
            "maxLength":"30",
            "type":"string",
            "description":"The column of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EntityUsage":{
            "title":"Entity Usage",
            "maxLength":"600",
            "type":"string",
            "description":"The entity usage of the corresponding attribute under ObjectMetadata.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the attributes record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the attributes record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDefType":{
            "title":"Control Type",
            "maxLength":"50",
            "type":"string",
            "description":"The control type of an attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrPrecision":{
            "title":"Attribute Precision",
            "type":"number",
            "description":"The precision of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSQLDerivedExprFlag":{
            "title":"SQL Derived Expression Flag",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the attribute is derived from SQL expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TableName":{
            "title":"Object Table Name",
            "type":"string",
            "description":"The table name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "DependsOn":{
            "title":"Depends On",
            "maxLength":"800",
            "type":"string",
            "description":"The attribute which is used to save the attribute dependencies for the object.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrScale":{
            "title":"Attribute Scale",
            "type":"number",
            "description":"The scale of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttrLength":{
            "title":"Length",
            "type":"number",
            "description":"The length of the attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LabelResourceId":{
            "title":"Label Resource ID",
            "maxLength":"700",
            "type":"string",
            "description":"The resource identifier of the label of the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attributes record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attribute Properties

Type: array

Title: Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Show Source

• Array of: object objectMetadata-childObjectMetadata-attributes-attributeProperties-item-response

{
    "title":"Attribute Properties",
    "type":"array",
    "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-attributes-attributeProperties-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : objectMetadata-childObjectMetadata-attributes-attributeProperties-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the attribute properties record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attribute properties record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute properties record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the attribute properties record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyCode: string
  Title: Property Name

  Maximum Length: 200

  The name of the property.
• PropertyGroup: string
  Title: Property Group

  Maximum Length: 30

  The name of the group to which the property belongs to.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 4000

  The value of the property.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute properties record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyGroup":{
            "title":"Property Group",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the group to which the property belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The value of the property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyCode":{
            "title":"Property Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute properties record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : objectMetadata-childObjectMetadata-childObjectMetadata-item-response

Type: object

Show Source

• AlternateKeys: string
  Title: Alternate Keys

  Read Only: true

  The alternate key of the child object metadata.
• APPStripe: string
  Title: Application Stripe

  Read Only: true

  Maximum Length: 80

  It specifies the application name of the child object.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the child object metadata record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the child object metadata record was created.
• Description: string
  Title: Description

  Read Only: true

  The description of the child object metadata.
• DescriptionResourceId: string
  Title: Description Resource ID

  Read Only: true

  The resource identifier of the description of the object.
• DisplayName: string
  Title: Display Name

  Read Only: true

  The display name of the child object metadata.
• DisplayNamePlural: string
  Title: Plural Title

  Read Only: true

  The display name of child object in plural form of the child object metadata.
• ExtensibleViewDefinition: string
  Title: Extensible View Definition

  Read Only: true

  Maximum Length: 600

  The extensible view definition of the child object.
• IsCustomFlag: boolean
  Title: Custom Object

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the child object metadata is custom.
• IsExtensible: string
  Title: Is Extensible

  Read Only: true

  Indicates whether the child object is extensible.
• KeyAttributes: string
  Title: User Keys

  Read Only: true

  The key attributes of the child object metadata.
• LabelResourceId: string
  Title: Label Resource ID

  Read Only: true

  Maximum Length: 700

  The resource identifier of the label of the object.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the child object metadata record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the child object metadata record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Title: Object Name

  Maximum Length: 128

  The language independent code of an child object metadata object, which uniquely identifies the object.
• ObjectDefinition: string
  Title: Object Definition

  Read Only: true

  Maximum Length: 600

  The fully qualified VO name for the child object metadata object.
• ParentObjectCode: string
  Title: Parent Object

  Maximum Length: 128

  The language independent code of the parent object which uniquely identifies the parent object.
• PluralLabelResourceId: string
  Title: Plural Label Resource ID

  Read Only: true

  Maximum Length: 700

  The resource identifier of the name in plural form of the child object.
• PrimaryEntityDefinition: string
  Title: Primary Entity Definition

  Read Only: true

  Maximum Length: 600

  The primary entity definition of the object under ChildObjectMetadata.
• PuidAttribute: string
  Title: Primary Alternate Key

  Read Only: true

  Maximum Length: 100

  The PUID of the child object metadata object.
• RestResource: string
  Title: REST Resource Code

  Read Only: true

  Maximum Length: 100

  The rest resource name of the child object metadata object.
• RestResourceIdentifier: string
  Title: REST Resource Identifier

  Read Only: true

  Maximum Length: 100

  The unique identifier of the child object metadata rest resource.
• UcmAccount: string
  Title: Account

  Read Only: true

  Maximum Length: 120

  The UCM account of the child object metadata object.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the child object metadata record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateKeys":{
            "title":"Alternate Keys",
            "type":"string",
            "description":"The alternate key of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RestResource":{
            "title":"REST Resource Code",
            "maxLength":"100",
            "type":"string",
            "description":"The rest resource name of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "APPStripe":{
            "title":"Application Stripe",
            "maxLength":"80",
            "type":"string",
            "description":"It specifies the application name of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PluralLabelResourceId":{
            "title":"Plural Label Resource ID",
            "maxLength":"700",
            "type":"string",
            "description":"The resource identifier of the name in plural form of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Name",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of an child object metadata object, which uniquely identifies the object.",
            "nullable":false,
            "x-queryable":true
        },
        "IsCustomFlag":{
            "title":"Custom Object",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the child object metadata is custom.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "DescriptionResourceId":{
            "title":"Description Resource ID",
            "type":"string",
            "description":"The resource identifier of the description of the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryEntityDefinition":{
            "title":"Primary Entity Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The primary entity definition of the object under ChildObjectMetadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RestResourceIdentifier":{
            "title":"REST Resource Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the child object metadata rest resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisplayNamePlural":{
            "title":"Plural Title",
            "type":"string",
            "description":"The display name of child object in plural form of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PuidAttribute":{
            "title":"Primary Alternate Key",
            "maxLength":"100",
            "type":"string",
            "description":"The PUID of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyAttributes":{
            "title":"User Keys",
            "type":"string",
            "description":"The key attributes of the child object metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectDefinition":{
            "title":"Object Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The fully qualified VO name for the child object metadata object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UcmAccount":{
            "title":"Account",
            "maxLength":"120",
            "type":"string",
            "description":"The UCM account of the child object metadata object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentObjectCode":{
            "title":"Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the parent object which uniquely identifies the parent object.",
            "nullable":false,
            "x-queryable":true
        },
        "ExtensibleViewDefinition":{
            "title":"Extensible View Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The extensible view definition of the child object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsExtensible":{
            "title":"Is Extensible",
            "type":"string",
            "description":"Indicates whether the child object is extensible.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LabelResourceId":{
            "title":"Label Resource ID",
            "maxLength":"700",
            "type":"string",
            "description":"The resource identifier of the label of the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the child object metadata record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : objectMetadata-childObjectMetadata-objectProperties-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the attribute properties record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attribute properties record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute properties record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the attribute properties record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyCode: string
  Title: Property Name

  Maximum Length: 200

  The name of the property.
• PropertyGroup: string
  Title: Property Group

  Maximum Length: 30

  The name of the group to which the property belongs to.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 4000

  The value of the property.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute properties record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyGroup":{
            "title":"Property Group",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the group to which the property belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The value of the property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyCode":{
            "title":"Property Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute properties record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : objectMetadata-childObjectMetadata-relationships-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the relationship of the child object metadata record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the relationship of the child object metadata record was created.
• IntersectionObjectCode: string
  Title: Intersection Object Code

  Maximum Length: 128

  The language independent code of the intersection object, which uniquely identifies the object.
• IntersectionObjectDisplayName: string
  Title: Intersection Object

  Read Only: true

  Maximum Length: 255

  The display name of the intersection object.
• IntersectionSourceAttribute: string
  Title: Intersection Source Attribute

  Maximum Length: 128

  The attribute of the intersection object which is associated with the relationship between source object and intersection object.
• IntersectionSrcVlaName: string
  Title: Intersection Source View Link Accessor Name

  Maximum Length: 300

  The name of the View Link Accessor, which is between source object and intersection object.
• IntersectionTargetAttribute: string
  Title: Intersection Target Attribute

  Maximum Length: 100

  The attribute of the intersection object which is associated with the relationship between intersection object and target object.
• IntersectionTrgtVlaName: string
  Title: Intersection Target View Link Accessor Name

  Maximum Length: 300

  The name of the View Link Accessor, which is between intersection object and target object.
• IsCustomRelationFlag: boolean
  Title: Custom Relation

  Maximum Length: 1

  Default Value: false

  Indicates whether the relationship is custom.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the child object metadata relationships record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the child object metadata relationships record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCode: string
  Title: Source Object Code

  Maximum Length: 128

  The language independent code of the source object of the relation.
• RelationCode: string
  Title: Relation Name

  Maximum Length: 500

  The language independent code of the relation which uniquely identifies the relation.
• RelationshipCardinality: string
  Title: Relationship Cardinality

  Maximum Length: 30

  The cardinality of the relationship, such as OneToOne or ManyToMany.
• RelationshipDisplayName: string
  Title: Relationship Display Name

  Maximum Length: 100

  The display name of the relationship.
• relationshipProperties: array Attribute Properties
  Title: Attribute Properties

  The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.
• RelationshipType: string
  Title: Relationship Type

  Maximum Length: 100

  The type of the relationship.
• SourceObjectAttributes: string
  Title: Source Object Attributes

  Read Only: true

  The attributes of the source object which is associated with the relationship.
• SourceObjectDisplayName: string
  Title: Source Object

  Read Only: true

  Maximum Length: 255

  The display name of the source object.
• SourceObjectVlaName: string
  Title: Source Object View Link Accessor Name

  Maximum Length: 300

  The View Link Accessor name of the source object.
• TargetObjectAttributes: string
  Title: Target Object Attributes

  Read Only: true

  The attributes of the target object which is associated with the relationship.
• TargetObjectCode: string
  Title: Target Object Code

  Maximum Length: 128

  The language independent code of the target object, which uniquely identifies the object.
• TargetObjectDisplayName: string
  Title: Target Object

  Read Only: true

  Maximum Length: 255

  The display name of the target object.
• TargetObjectVlaName: string
  Title: Target Object View Link Accessor Name

  Maximum Length: 300

  The View Link Accessor name of the child object metadata source object.
• ViewLinkDef: string
  Title: View Link Definition

  Maximum Length: 600

  The fully qualified name of the view link related to relationship.

{
    "type":"object",
    "properties":{
        "IsCustomRelationFlag":{
            "title":"Custom Relation",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the relationship is custom.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SourceObjectAttributes":{
            "title":"Source Object Attributes",
            "type":"string",
            "description":"The attributes of the source object which is associated with the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the relationship of the child object metadata record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntersectionSrcVlaName":{
            "title":"Intersection Source View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the View Link Accessor, which is between source object and intersection object.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewLinkDef":{
            "title":"View Link Definition",
            "maxLength":"600",
            "type":"string",
            "description":"The fully qualified name of the view link related to relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":"100",
            "type":"string",
            "description":"The type of the relationship.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Source Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the source object of the relation.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectCode":{
            "title":"Target Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the target object, which uniquely identifies the object.",
            "nullable":false,
            "x-queryable":true
        },
        "IntersectionTrgtVlaName":{
            "title":"Intersection Target View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the View Link Accessor, which is between intersection object and target object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TargetObjectAttributes":{
            "title":"Target Object Attributes",
            "type":"string",
            "description":"The attributes of the target object which is associated with the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipCardinality":{
            "title":"Relationship Cardinality",
            "maxLength":"30",
            "type":"string",
            "description":"The cardinality of the relationship, such as OneToOne or ManyToMany.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the child object metadata relationships record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectDisplayName":{
            "title":"Target Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the target object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDisplayName":{
            "title":"Relationship Display Name",
            "maxLength":"100",
            "type":"string",
            "description":"The display name of the relationship.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the relationship of the child object metadata record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "relationshipProperties":{
            "title":"Attribute Properties",
            "type":"array",
            "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-response"
            }
        },
        "IntersectionObjectDisplayName":{
            "title":"Intersection Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the intersection object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectVlaName":{
            "title":"Target Object View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The View Link Accessor name of the child object metadata source object.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectDisplayName":{
            "title":"Source Object",
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntersectionObjectCode":{
            "title":"Intersection Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The language independent code of the intersection object, which uniquely identifies the object.",
            "nullable":true,
            "x-queryable":true
        },
        "IntersectionTargetAttribute":{
            "title":"Intersection Target Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute of the intersection object which is associated with the relationship between intersection object and target object.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationCode":{
            "title":"Relation Name",
            "maxLength":"500",
            "type":"string",
            "description":"The language independent code of the relation which uniquely identifies the relation.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectVlaName":{
            "title":"Source Object View Link Accessor Name",
            "maxLength":"300",
            "type":"string",
            "description":"The View Link Accessor name of the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "IntersectionSourceAttribute":{
            "title":"Intersection Source Attribute",
            "maxLength":"128",
            "type":"string",
            "description":"The attribute of the intersection object which is associated with the relationship between source object and intersection object.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the child object metadata relationships record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Attribute Properties

Type: array

Title: Attribute Properties

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

Show Source

• Array of: object objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-response

{
    "title":"Attribute Properties",
    "type":"array",
    "description":"The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.",
    "items":{
        "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-response"
    }
}

Nested Schema : objectMetadata-childObjectMetadata-relationships-relationshipProperties-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the attribute properties record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the attribute properties record was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the attribute properties record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the attribute properties record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyCode: string
  Title: Property Name

  Maximum Length: 200

  The name of the property.
• PropertyGroup: string
  Title: Property Group

  Maximum Length: 30

  The name of the group to which the property belongs to.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 4000

  The value of the property.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attribute properties record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the attribute properties record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyGroup":{
            "title":"Property Group",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the group to which the property belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"4000",
            "type":"string",
            "description":"The value of the property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyCode":{
            "title":"Property Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the attribute properties record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attributes

Operation: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes

Parameters:

• ObjectCode: $request.path.ObjectCode
• ObjectCode2: $request.path.ObjectCode2

The attributes resource is used to view, create, update, and delete attributes. It represents attribute specific properties defined in the object definition.

childObjectMetadata

Operation: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/childObjectMetadata

Parameters:

• ObjectCode: $request.path.ObjectCode
• ObjectCode2: $request.path.ObjectCode2

The child object metadata resource is used to view, create, update, and delete child object metadata. It represents object hierarchy and can be used to navigate to child object specific relations and attributes.

objectProperties

Operation: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/objectProperties

Parameters:

• ObjectCode: $request.path.ObjectCode
• ObjectCode2: $request.path.ObjectCode2

The attribute properties resource is used to view, create, update, and delete attribute properties. It represents custom attribute properties.

relationships

Operation: /crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/relationships

Parameters:

• ObjectCode: $request.path.ObjectCode
• ObjectCode2: $request.path.ObjectCode2

The relationships resource is used to view, create, update, and delete a relationship. It represents relationships defined on all objects.

Back to Top