Jump to

• Request
• Response

Create a child object metadata

post

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

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=

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ObjectCode: string
  Title: Object Name

  Maximum Length: 128

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

  Maximum Length: 128

  The language independent code of the parent object which uniquely identifies the parent object.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        }
    }
}

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-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 : 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."
        }
    }
}

Back to Top