Get all artifact resources
get
/fscmRestApi/resources/11.13.18.05/artifactResources
Request
Query Parameters
-
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- ArtifactCodeFinder Finds all the artifact resources of one or more particular types that match with the specified artifact code.
Finder Variables- Active; string; Indicates whether to get active or inactive artifacts.
- ArtifactType; string; A list of comma separated artifact types.
- Code; string; Data artifact unique code. This is used to find all artifacts where artifact code matches the passed value.
- SourceArtifactIdentifier; integer; Unique identifier of the source resource. This is used to find all artifacts where SourceArtifactId matches the passed value.
- PrimaryKey Finds all the artifact resources that match the primary key criteria specified.
Finder Variables- ArtifactId; integer; The unique identifier for the artifact resource.
- TypeKeywordFinder Finds all the artifact resources of one or more particular types that match with the specified keyword in artifact name and artifact code.
Finder Variables- Active; string; Indicates whether to get active or inactive artifacts.
- ArtifactType; string; A list of comma separated artifact types.
- Keyword; string; Keyword; string; to search in artifact name and artifact code.
- OriginResourceFlag; boolean; Indicates whether to get parent resources. This is used to find all artifacts where SourceArtifactId is NULL.
- SourceArtifactIdentifier; integer; Unique identifier of the source resource. This is used to find all artifacts where SourceArtifactId matches the passed value.
- ArtifactCodeFinder Finds all the artifact resources of one or more particular types that match with the specified artifact code.
-
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:- ActiveFlag; boolean; Indicates whether a resource is active or inactive. The default value is Y.
- ArtifactCode; string; The data artifact unique code, such as ACADSTRUCTURERESOURCES.
- ArtifactId; integer; The unique identifier of an artifact resource.
- ArtifactName; string; The name of a data resource.
- ArtifactTypeCode; string; The type of the data resource, for example, a collection of REST resources or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE. The default value is ORA_HEY_RESOURCE.
- ArtifactTypeMeaning; string; The meaning of the artifact type code. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE.
- DataTypeCode; string; The attribute type code. For example, number, string, boolean, date, date time, time or mixed. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE.
- DataTypeMeaning; string; The meaning of the attribute type code. For example, number, string, boolean, date, date time, time or mixed. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE.
- Description; string; The description of a data resource.
- LastUpdateDate; string; The date and time when the resource was updated.
- LastUpdatedBy; string; The person who updated the resource.
- MappedCategories; integer; The number of categories mapped to this resource.
- MappedDataContracts; integer; The number of data contracts using this variable.
- MappedProfiles; integer; The number of profiles using this resource.
- SeedDataLock; integer; Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
- SourceArtifactId; integer; The unique identifier of the source resource.
- SourceObjectName; string; The name of the source object resource. For example, the REST resource, the view object name or file name.
- UseAsLovFlag; boolean; Indicates whether a resource can be used as a source for a list of values. The default value is N.
- VariableTypeCode; string; The element type code. For example, single variable, list variable, multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE.
- VariableTypeMeaning; string; The meaning of the element type code. For example, single variable, list variable, multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE.
-
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 : artifactResources
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : artifactResources-item-response
Type:
Show Source
object-
ActiveFlag: boolean
Title:
StatusMaximum Length:1Default Value:trueIndicates whether a resource is active or inactive. The default value is Y. -
ArtifactCode: string
Title:
CodeMaximum Length:50The data artifact unique code, such as ACADSTRUCTURERESOURCES. -
ArtifactId: integer
(int64)
Title:
Artifact IDThe unique identifier of an artifact resource. -
ArtifactName: string
Title:
NameMaximum Length:50The name of a data resource. -
artifactRelations: array
Artifact Element Relations
Title:
Artifact Element RelationsThe resource is used to view the artifact element relations. For example, an artifact element can be a REST resource and this element has related child resources. -
ArtifactTypeCode: string
Title:
Type CodeMaximum Length:30The type of the data resource, for example, a collection of REST resources or rule variables. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE. The default value is ORA_HEY_RESOURCE. -
ArtifactTypeMeaning: string
Title:
Resource TypeRead Only:trueMaximum Length:80The meaning of the artifact type code. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE. -
DataTypeCode: string
Title:
Data Type CodeRead Only:trueThe attribute type code. For example, number, string, boolean, date, date time, time or mixed. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
DataTypeMeaning: string
Title:
Data TypeRead Only:trueThe meaning of the attribute type code. For example, number, string, boolean, date, date time, time or mixed. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE. -
Description: string
Title:
DescriptionMaximum Length:240The description of a data resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the resource was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The person who updated the resource. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappedCategories: integer
Title:
Mapped CategoriesRead Only:trueThe number of categories mapped to this resource. -
MappedDataContracts: integer
Title:
Mapped Data ContractsRead Only:trueThe number of data contracts using this variable. -
MappedProfiles: integer
Title:
Mapped ProfilesRead Only:trueThe number of profiles using this resource. -
SeedDataLock: integer
(int32)
Title:
Predefined DataDefault Value:0Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated. -
SourceArtifactId: integer
(int64)
Title:
Parent Resource IDThe unique identifier of the source resource. -
SourceObjectName: string
Title:
Source Object NameRead Only:trueThe name of the source object resource. For example, the REST resource, the view object name or file name. -
UseAsLovFlag: boolean
Title:
Use as List of ValuesMaximum Length:1Default Value:falseIndicates whether a resource can be used as a source for a list of values. The default value is N. -
VariableTypeCode: string
Title:
Variable Type CodeRead Only:trueThe element type code. For example, single variable, list variable, multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE. -
VariableTypeMeaning: string
Title:
Variable TypeRead Only:trueThe meaning of the element type code. For example, single variable, list variable, multicolumn list variable. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE.
Nested Schema : Artifact Element Relations
Type:
arrayTitle:
Artifact Element RelationsThe resource is used to view the artifact element relations. For example, an artifact element can be a REST resource and this element has related child resources.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : artifactResources-artifactRelations-item-response
Type:
Show Source
object-
artifactElementAttributes: array
Artifact Element Attributes
Title:
Artifact Element AttributesThe 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 PropertiesThe resource is used to view data artifact element properties. The properties could be, for example, finders and actions. -
ArtifactLevel: integer
(int32)
Title:
Artifact LevelThe level of the element in hierarchy. -
ArtifactRelationId: integer
(int64)
Title:
Artifact Relation IDThe unique identifier of an artifact relation. -
ArtifactSequence: integer
(int32)
Title:
Artifact SequenceThe sequence number of the element in hierarchy. -
ElementCode: string
Title:
Element CodeRead Only:trueMaximum Length:50The data artifact element unique code, such as ACADSTRUCTUREREST. -
ElementDescription: string
Title:
Element DescriptionRead Only:trueMaximum Length:240The description of the data artifact element. -
ElementId: integer
(int64)
Title:
Element IDThe unique identifier of an artifact element. -
ElementName: string
Title:
Element NameRead Only:trueMaximum Length:50The name of the data artifact element. -
ElementSourcePath: string
Title:
Source PathRead Only:trueMaximum Length:500The source path of the element. For example, in case of a view object, this attribute represents the location of this object. -
ElementTypeCode: string
Title:
Element Type CodeRead Only:trueMaximum Length:30The 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. -
ElementTypeMeaning: string
Title:
Element TypeRead Only:trueMaximum Length:80The 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 CodesRead Only:trueMaximum Length:512The concatenated list of valid HTTP actions of a data artifact element. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ParentRelationSequence: integer
(int64)
Title:
Parent Relation SequenceThe sequence number of the parent element. -
RelationSequence: integer
(int64)
Title:
Relation SequenceThe sequence number of the element. -
SourceObjectName: string
Title:
Source Object NameRead Only:trueMaximum Length:200The 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 PathMaximum Length:500The source path of the artifact representing the relationship with the parent element. For example, in case of a view object, this attribute represents the path of the view link.
Nested Schema : Artifact Element Attributes
Type:
arrayTitle:
Artifact Element AttributesThe 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:
arrayTitle:
Artifact Element PropertiesThe resource is used to view data artifact element properties. The properties could be, for example, finders and actions.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested 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.
Nested Schema : artifactResources-artifactRelations-artifactElementProperties-item-response
Type:
Show Source
object-
Description: string
Title:
Property DescriptionMaximum Length:240The description of a data artifact element property. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PropertyCode: string
Title:
Property CodeMaximum Length:50The data artifact element property unique code, such as FINDERNAME. -
PropertyId: integer
(int64)
Title:
Property IDThe unique identifier of an artifact element property. -
PropertyName: string
Title:
Property NameMaximum Length:50The name of a data artifact element property. -
PropertyTypeCode: string
Title:
Property Type CodeMaximum Length:30The 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. -
PropertyTypeMeaning: string
Title:
Property TypeRead Only:trueMaximum Length:80The 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 ValueMaximum Length:900The value of a data artifact element property.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source