Jump to

• Request
• Response

Get all child object metadata

get

/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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a child object metadata with the specified primary key.
    Finder Variables
  • childObjectCodeFinder The child object code finder.
    Finder Variables
    • ObjectCode; string; The language independent code of the object.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AlternateKeys; string; The alternate key of the child object metadata.
  • CreatedBy; string; The user who created the child object metadata record.
  • CreationDate; string; The date when the child object metadata record was created.
  • Description; string; The description of the child object metadata.
  • DescriptionResourceId; string; The resource identifier of the description of the object.
  • DisplayName; string; The display name of the child object metadata.
  • DisplayNamePlural; string; The display name of child object in plural form of the child object metadata.
  • ExtensibleViewDefinition; string; The extensible view definition of the child object.
  • IsCustomFlag; boolean; Indicates whether the child object metadata is custom.
  • IsExtensible; string; Indicates whether the child object is extensible.
  • KeyAttributes; string; The key attributes of the child object metadata.
  • LabelResourceId; string; The resource identifier of the label of the object.
  • LastUpdateDate; string; The date when the child object metadata record was last updated.
  • LastUpdatedBy; string; The user who last updated the child object metadata record.
  • ObjectCode; string; The language independent code of an child object metadata object, which uniquely identifies the object.
  • ObjectDefinition; string; The fully qualified VO name for the child object metadata object.
  • ParentObjectCode; string; The language independent code of the parent object which uniquely identifies the parent object.
  • PluralLabelResourceId; string; The resource identifier of the name in plural form of the child object.
  • PrimaryEntityDefinition; string; The primary entity definition of the object under ChildObjectMetadata.
  • PuidAttribute; string; The PUID of the child object metadata object.
  • RestResource; string; The rest resource name of the child object metadata object.
  • RestResourceIdentifier; string; The unique identifier of the child object metadata rest resource.
  • UcmAccount; string; The UCM account of the child object metadata object.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  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-childObjectMetadata

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/objectMetadata-childObjectMetadata-childObjectMetadata-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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 : 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":{
        "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
            }
        },
        "AlternateKeys":{
            "title":"Alternate Keys",
            "type":"string",
            "description":"The alternate key of the child object metadata.",
            "nullable":true,
            "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
        },
        "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
        },
        "DescriptionResourceId":{
            "title":"Description Resource ID",
            "type":"string",
            "description":"The resource identifier of the description of the object.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "IsExtensible":{
            "title":"Is Extensible",
            "type":"string",
            "description":"Indicates whether the child object is extensible.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "UcmAccount":{
            "title":"Account",
            "maxLength":120,
            "type":"string",
            "description":"The UCM account of the child object metadata object.",
            "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"
            }
        }
    }
}

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