Get an element attribute
get
/fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations/{ArtifactRelationId}/child/artifactElementAttributes/{AttributeId}
Request
Path Parameters
-
ArtifactId(required): integer(int64)
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=
-
ArtifactRelationId(required): integer(int64)
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=
-
AttributeId(required): integer(int64)
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 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 : artifactResources-artifactRelations-artifactElementAttributes-item-response
Type:
Show Source
object-
AllowChangesTypeCode: string
Title:
Allow ChangesMaximum Length:30Indicates when an element attribute is updatable. -
AllowLovAllFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, the value All appears in the list of values for the association criteria. -
AllowLovMultipleFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, multiple values can be selected from the list of values for the association criteria. -
AttributeCode: string
Title:
Attribute CodeMaximum Length:50The data artifact element attribute unique code, such as Course ID. -
AttributeCodeAlias: string
Title:
Attribute AliasMaximum Length:500The alias name of the element attribute. -
AttributeDataTypeCode: string
Title:
Data Type CodeMaximum Length:30The type of the data artifact element attribute, for example, integer or string. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeDecimalPlaces: integer
(int64)
Title:
Decimal PlacesThe precision of an element attribute. -
AttributeId: integer
(int64)
Title:
Attribute IDThe unique identifier of an artifact element attribute. -
AttributeLength: integer
(int64)
Title:
Attribute LengthThe length of an element attribute. -
AttributeName: string
Title:
Attribute NameMaximum Length:50The name of the data artifact element attribute. -
AttributeSequence: integer
(int32)
Title:
Attribute SequenceThe sequence of the attribute in the element. -
AttributeTypeMeaning: string
Title:
Data TypeRead Only:trueMaximum Length:80The meaning of the element attribute data type code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
AttributeWeight: number
Title:
WeightThe value of an element attribute when compared to another element attribute. -
AvailableToRulesUIFlag: boolean
Maximum Length:
1Default Value:trueIndicates that this attribute is available for use in the rules framework. The default value is Y. -
AvlblToQueryFilterFlag: boolean
Maximum Length:
1Default Value:trueIndicates that this attribute is available for filtering query data in the data selection tool. The default value is Y. -
AvlblToQueryJoinFlag: boolean
Maximum Length:
1Default Value:trueIndicates that this attribute is available for joining query tables in the data selection tool. The default value is Y. -
CascdLovValueFieldFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether this attribute acts as the value field of this cascading list of values resource element. The default value is N. In cascading list of values, the values displayed depend on selection of a value in another field. For example, academic programs list of values depend on what's selected for career field. -
DefaultValue: string
Title:
Default ValueMaximum Length:512The default value of an element attribute. -
DefaultValueJSON: string
(byte)
Default value of the attribute in JSON format. Used by list or multicolumn list variables.
-
Description: string
Title:
Attribute DescriptionMaximum Length:240The description of a data artifact element attribute. -
FinderAttributeNameFive: string
Title:
Finder 5 NameMaximum Length:512The finder name 5 of an element attribute. -
FinderAttributeNameFour: string
Title:
Finder 4 NameMaximum Length:512The finder name 4 of an element attribute. -
FinderAttributeNameOne: string
Title:
Finder 1 NameMaximum Length:512The finder name 1 of an element attribute. -
FinderAttributeNameThree: string
Title:
Finder 3 NameMaximum Length:512The finder name 3 of an element attribute. -
FinderAttributeNameTwo: string
Title:
Finder 2 NameMaximum Length:512The finder name 2 of an element attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup TypeMaximum Length:30The list of values lookup type of an element attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values Resource IDThe list of values resource ID of an element attribute. -
LovDisplayFieldFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether this attribute acts as the display field of this list of values resource element. The default value is N. -
LovDisplayFields: string
Title:
List of Values Display FieldsMaximum Length:900The comma separated field names of the list of values resource associated with this attribute. -
LovFinderName: string
Title:
List of Values Finder NameMaximum Length:512The list of values finder name of an element attribute. -
LovSourceResourceName: string
Title:
List of Values Source Resource NameMaximum Length:200The source resource name for the list of values resource of an element attribute. -
LovValueField: string
Title:
List of Values FieldMaximum Length:900The field name of the list of values resource associated with this attribute. -
LovValueFieldFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether this attribute acts as the value field of this list of values resource element. The default value is N. -
MaximumInRange: integer
(int64)
Title:
Maximum ValueThe maximum value of an element attribute. -
MinimumInRange: integer
(int64)
Title:
Minimum ValueThe minimum value of an element attribute. -
ParentAttributeIdFive: integer
(int64)
Title:
Parent Attribute 5 IDThe parent attribute 5 of an element attribute. -
ParentAttributeIdFour: integer
(int64)
Title:
Parent Attribute 4 IDThe parent attribute 4 of an element attribute. -
ParentAttributeIdOne: integer
(int64)
Title:
Parent Attribute 1 IDThe parent attribute 1 of an element attribute. -
ParentAttributeIdThree: integer
(int64)
Title:
Parent Attribute 3 IDThe parent attribute 3 of an element attribute. -
ParentAttributeIdTwo: integer
(int64)
Title:
Parent Attribute 2 IDThe parent attribute 2 of an element attribute. -
PrimaryObjectFlag: boolean
Title:
Primary ObjectMaximum Length:1Indicates when an element attribute is primary. -
QueryableFlag: boolean
Title:
Can Be QueriedMaximum Length:1Indicates whether an element attribute can be queried or not. -
QueryParameterFlag: boolean
Maximum Length:
1Indicates whether the attribute can be queried in REST. -
RequiredFlag: boolean
Title:
RequiredMaximum Length:1Indicates whether an element attribute is required or not. -
SourceObjectName: string
Title:
Source Object NameMaximum Length:200The name of the attribute in the source object which is represented by this element. For example, the REST resource attribute name or the view object attribute name. -
TranslatableFlag: boolean
Title:
TranslatableMaximum Length:1Indicates whether an element attribute is translatable or not. -
UpdatableFlag: boolean
Title:
UpdatableMaximum Length:1Indicates whether an element attribute is updatable or not.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- HeyCommonServiceAM_HeyLookup1_1
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_ATTRIBUTE_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: AttributeDataTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: