Get all attributes
get
/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/childObjectMetadata/{ObjectCode2}/child/attributes
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- AttributeCodeFinder The attribute code finder.
Finder Variables- AttributeCode; string; The name of the attribute.
- PrimaryKey Finds an attribute with the specified primary key.
Finder Variables
- AttributeCodeFinder The attribute code finder.
-
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:- AliasName; string; The alias name of the corresponding attribute under ObjectMetadata.
- AttrColumn; string; The column of the attribute.
- AttrLength; number; The length of the attribute.
- AttrPrecision; number; The precision of the attribute.
- AttrScale; number; The scale of the attribute.
- AttributeCode; string; The name of the attribute.
- AttributeDefType; string; The control type of an attribute.
- AttributeTable; string; The table associated with the attribute.
- AttributeType; string; The type of the attribute.
- ColumnType; string; The column type of the attribute.
- CreatedBy; string; The user who created the attributes record.
- CreationDate; string; The date when the attributes record was created.
- DefaultValue; string; The default value of the attribute.
- DependsOn; string; The attribute which is used to save the attribute dependencies for the object.
- Description; string; The description of the attribute.
- DescriptionResourceId; string; The resource identifier of the description of the attribute.
- DisplayName; string; The display name of the attribute.
- EntityUsage; string; The entity usage of the corresponding attribute under ObjectMetadata.
- IsCustomFlag; boolean; Indicates whether the attribute is custom.
- IsQueryableFlag; boolean; Indicates whether the attribute can be queried.
- IsSQLDerivedExprFlag; boolean; Indicates whether the attribute is derived from SQL expression.
- IsUpdatableFlag; boolean; Indicates whether the attribute is updatable.
- LabelResourceId; string; The resource identifier of the label of the attribute.
- LastUpdateDate; string; The date when the attributes record was last updated.
- LastUpdatedBy; string; The user who last updated the attributes record.
- MandatoryFlag; boolean; Indicates whether the attribute is mandatory.
- TableName; string; The table name of the attribute.
- TransientFlag; boolean; Indicates whether the attribute is transient attribute or not.
-
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:
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 TopResponse
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.
Root Schema : objectMetadata-childObjectMetadata-attributes
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-attributes-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : objectMetadata-childObjectMetadata-attributes-attributeProperties-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.