1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Object Metadata
  4. Attributes

Get all attributes

get

/crmRestApi/resources/11.13.18.05/objectMetadata/{ObjectCode}/child/attributes

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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.
    • 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
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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-attributes
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : objectMetadata-attributes-item-response
    Type: object
    Show Source
    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 : objectMetadata-attributes-attributeProperties-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    The following example shows how to get all attributes of an object metadata by submitting a get request on the REST resource using cURL.

    cURL Command

    curl -u <username:password> \ 'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule/child/attributes' -X GET

    Example of Response Body

    The following shows an example of the response body in JSON format.

    {
    "items": [
        {
            "AttributeCode": "AccExtRuleId",
            "DisplayName": "Access Extension Rule ID",
            "AttributeTable": "ZCA_AG_ACC_EXT_RULES",
            "AttributeType": "java.lang.Long",
            "Description": null,
            "DefaultValue": null,
            "AttrColumn": "ACC_EXT_RULE_ID",
            "ColumnType": "NUMERIC",
            "TableName": "ZCA_AG_ACC_EXT_RULES",
            "EntityUsage": "AccessExtnRulesEO",
            "AliasName": "ACC_EXT_RULE_ID",
            "AttrLength": 18,
            "AttrPrecision": 18,
            "AttrScale": 0,
            "IsCustomFlag": false,
            "TransientFlag": false,
            "IsUpdatableFlag": true,
            "MandatoryFlag": true,
            "IsQueryableFlag": true,
            "IsSQLDerivedExprFlag": false,
            "LabelResourceId": "${adfBundle['oracle.apps.crmCommon.simplifiedAccess.accessGroups.resource.AccessGroupsAttrBundle']['ColAttr.AccessExtensionRuleID.AccessExtnRulesVO.AccExtRuleId']}",
            "DescriptionResourceId": null,
            "CreatedBy": "FUSION_APPS_CRM_SOA_APPID",
            "CreationDate": "2024-12-02T12:56:03.340+00:00",
            "LastUpdateDate": "2024-12-02T12:56:03.371+00:00",
            "LastUpdatedBy": "FUSION_APPS_CRM_SOA_APPID",
            "DependsOn": null,
            "AttributeDefType": "NUMBER",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule/child/attributes/AccExtRuleId",
                    "name": "attributes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule/child/attributes/AccExtRuleId",
                    "name": "attributes",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule",
                    "name": "objectMetadata",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule/child/attributes/AccExtRuleId/child/attributeProperties",
                    "name": "attributeProperties",
                    "kind": "collection"
                }
            ]
        }, . . .
    ],
    "count": 22,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectMetadata/AccessExtensionRule/child/attributes",
            "name": "attributes",
            "kind": "collection"
        }
    ]
}
    Back to Top