Get an artifact element
get
/fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}
Request
Path Parameters
-
ElementId(required): integer(int64)
The unique identifier of an artifact element.
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(required):
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(required):
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 : artifactElements-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Status
Maximum Length:1
Default Value:true
Indicates whether an artifact element is active or inactive. The default value is Y. -
artifactElementAttributes: array
Artifact Element Attributes
Title:
Artifact Element Attributes
The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name. -
artifactElementProperties: array
Artifact Element Properties
Title:
Artifact Element Properties
The resource is used to view data artifact element properties. The properties could be, for example, finders and actions. -
Description: string
Title:
Element Description
Maximum Length:240
The description of a data artifact element. -
ElementCode: string
Title:
Element Code
Maximum Length:50
The data artifact element unique code, such as ACADSTRUCTUREREST. -
ElementId: integer
(int64)
Title:
Element ID
The unique identifier of an artifact element. -
ElementName: string
Title:
Element Name
Maximum Length:50
The name of a data artifact element. -
ElementTypeCode: string
Title:
Element Type Code
Maximum Length:30
The type of the data artifact element, for example, a REST resource. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE. The default value is ORA_HEY_REST_RESOURCE. -
ElementTypeMeaning: string
Title:
Element Type
Read Only:true
Maximum Length:80
The meaning of the data artifact element type code. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE. -
HTTPActionCodes: string
Title:
Action Codes
Maximum Length:512
The concatenated list of valid HTTP actions of a data artifact element. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceObjectName: string
Title:
Source Object Name
Maximum Length:200
The name of the source object which is represented by this element. For example, the REST resource or child resource name, the view object name or file name. -
SourcePath: string
Title:
Source Path
Maximum Length:500
The source path of the element. For example, in case of a view object, this attribute represents the location of this object.
Nested Schema : Artifact Element Attributes
Type:
array
Title:
Artifact Element Attributes
The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.
Show Source
Nested Schema : Artifact Element Properties
Type:
array
Title:
Artifact Element Properties
The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : artifactElements-artifactElementAttributes-item-response
Type:
Show Source
object
-
AllowChangesTypeCode: string
Title:
Allow Changes
Maximum Length:30
Indicates when an element attribute is updatable. -
AllowLovAllFlag: boolean
Maximum Length:
1
Contains 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:
1
Contains 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 Code
Maximum Length:50
The data artifact element attribute unique code, such as Course ID. -
AttributeCodeAlias: string
Title:
Attribute Alias
Maximum Length:500
The alias name of the element attribute. -
AttributeDataTypeCode: string
Title:
Data Type Code
Maximum Length:30
The 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 Places
The precision of an element attribute. -
AttributeId: integer
(int64)
Title:
Attribute ID
The unique identifier of an artifact element attribute. -
AttributeLength: integer
(int64)
Title:
Attribute Length
The length of an element attribute. -
AttributeName: string
Title:
Attribute Name
Maximum Length:50
The name of the data artifact element attribute. -
AttributeSequence: integer
(int32)
Title:
Attribute Sequence
The sequence of the attribute in the element. -
AttributeTypeMeaning: string
Title:
Data Type
Read Only:true
Maximum Length:80
The 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:
Weight
The weightage of an element attribute. -
AvailableToRulesUIFlag: boolean
Maximum Length:
1
Default Value:true
Indicates that this attribute is available for use in the rules framework. The default value is Y. -
AvlblToQueryFilterFlag: boolean
Maximum Length:
1
Default Value:true
Indicates that this attribute is available for filtering query data in the data selection tool. The default value is Y. -
AvlblToQueryJoinFlag: boolean
Maximum Length:
1
Default Value:true
Indicates that this attribute is available for joining query tables in the data selection tool. The default value is Y. -
CascdLovValueFieldFlag: boolean
Maximum Length:
1
Default Value:false
Indicates 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 is selected for career field. -
DefaultValue: string
Title:
Default Value
Maximum Length:512
The default value of an element attribute. -
DefaultValueJSON: string
(byte)
Default value of the attribute in JSON format. Used by list or multi column list variables.
-
Description: string
Title:
Attribute Description
Maximum Length:240
The description of a data artifact element attribute. -
FinderAttributeNameFive: string
Title:
Finder 5 Name
Maximum Length:512
The finder name 5 of an element attribute. -
FinderAttributeNameFour: string
Title:
Finder 4 Name
Maximum Length:512
The finder name 4 of an element attribute. -
FinderAttributeNameOne: string
Title:
Finder 1 Name
Maximum Length:512
The finder name 1 of an element attribute. -
FinderAttributeNameThree: string
Title:
Finder 3 Name
Maximum Length:512
The finder name 3 of an element attribute. -
FinderAttributeNameTwo: string
Title:
Finder 2 Name
Maximum Length:512
The finder name 2 of an element attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupTypeCode: string
Title:
List of Values Lookup Type
Maximum Length:30
The list of values lookup type of an element attribute. -
LovArtifactId: integer
(int64)
Title:
List of Values Resource ID
The list of values resource id of an element attribute. -
LovDisplayFieldFlag: boolean
Maximum Length:
1
Default Value:false
Indicates 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 Fields
Maximum Length:900
The comma separated field names of the list of values resource associated with this attribute. -
LovFinderName: string
Title:
List of Values Finder Name
Maximum Length:512
The list of values finder name of an element attribute. -
LovSourceResourceName: string
Title:
List of Values Source Resource Name
Maximum Length:200
The source resource name for the list of values resource of an element attribute. -
LovValueField: string
Title:
List of Values Field
Maximum Length:900
The field name of the list of values resource associated with this attribute. -
LovValueFieldFlag: boolean
Maximum Length:
1
Default Value:false
Indicates 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 Value
The maximum value of an element attribute. -
MinimumInRange: integer
(int64)
Title:
Minimum Value
The minimum value of an element attribute. -
ParentAttributeIdFive: integer
(int64)
Title:
Parent Attribute 5 ID
The parent attribute 5 of an element attribute. -
ParentAttributeIdFour: integer
(int64)
Title:
Parent Attribute 4 ID
The parent attribute 4 of an element attribute. -
ParentAttributeIdOne: integer
(int64)
Title:
Parent Attribute 1 ID
The parent attribute 1 of an element attribute. -
ParentAttributeIdThree: integer
(int64)
Title:
Parent Attribute 3 ID
The parent attribute 3 of an element attribute. -
ParentAttributeIdTwo: integer
(int64)
Title:
Parent Attribute 2 ID
The parent attribute 2 of an element attribute. -
PrimaryObjectFlag: boolean
Title:
Primary Object
Maximum Length:1
Indicates when an element attribute is primary. -
QueryableFlag: boolean
Title:
Can Be Queried
Maximum Length:1
Indicates whether an element attribute can be queried or not. -
QueryParameterFlag: boolean
Maximum Length:
1
Indicates whether the attribute can be queried in REST. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates whether an element attribute is required or not. -
SourceObjectName: string
Title:
Source Object Name
Maximum Length:200
The 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:
Translatable
Maximum Length:1
Indicates whether an element attribute is translatable or not. -
UpdatableFlag: boolean
Title:
Updatable
Maximum Length:1
Indicates whether an element attribute is updatable or not.
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.
Nested Schema : artifactElements-artifactElementProperties-item-response
Type:
Show Source
object
-
Description: string
Title:
Property Description
Maximum Length:240
The description of a data artifact element property. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PropertyCode: string
Title:
Property Code
Maximum Length:50
The data artifact element property unique code, such as FINDERNAME. -
PropertyId: integer
(int64)
Title:
Property ID
The unique identifier of an artifact element property. -
PropertyName: string
Title:
Property Name
Maximum Length:50
The name of a data artifact element property. -
PropertyTypeCode: string
Title:
Property Type Code
Maximum Length:30
The type of the data artifact element property, for example, a finder. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_PROPERTY_TYPE. The default value is ORA_HEY_FINDER_TYPE. -
PropertyTypeMeaning: string
Title:
Property Type
Read Only:true
Maximum Length:80
The meaning of the element property type code. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_PROPERTY_TYPE. -
PropertyValue: string
Title:
Property Value
Maximum Length:900
The value of a data artifact element property.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- HeyCommonServiceAM_HeyLookup1_1
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_ELEMENT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ElementTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- artifactElementAttributes
-
Operation: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementAttributesParameters:
- ElementId:
$request.path.ElementId
The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name. - ElementId:
- artifactElementProperties
-
Operation: /fscmRestApi/resources/11.13.18.05/artifactElements/{ElementId}/child/artifactElementPropertiesParameters:
- ElementId:
$request.path.ElementId
The resource is used to view data artifact element properties. The properties could be, for example, finders and actions. - ElementId: