Get all artifact resources

get

/fscmRestApi/resources/11.13.18.05/artifactResources

Request

Query Parameters
  • 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

    • 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.
  • 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:
    • 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.
  • 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 : artifactResources
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : artifactResources-item-response
Type: object
Show Source
  • Title: Status
    Maximum Length: 1
    Default Value: true
    Indicates whether a resource is active or inactive. The default value is Y.
  • Title: Code
    Maximum Length: 50
    The data artifact unique code, such as ACADSTRUCTURERESOURCES.
  • Title: Artifact ID
    The unique identifier of an artifact resource.
  • Title: Name
    Maximum Length: 50
    The name of a data resource.
  • Artifact Element Relations
    Title: Artifact Element Relations
    The 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.
  • Title: Type Code
    Maximum Length: 30
    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.
  • Title: Resource Type
    Read Only: true
    Maximum Length: 80
    The meaning of the artifact type code. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE.
  • Title: Data Type Code
    Read Only: true
    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.
  • Title: Data Type
    Read Only: true
    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.
  • Title: Description
    Maximum Length: 240
    The description of a data resource.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the resource was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The person who updated the resource.
  • Links
  • Title: Mapped Categories
    Read Only: true
    The number of categories mapped to this resource.
  • Title: Mapped Data Contracts
    Read Only: true
    The number of data contracts using this variable.
  • Title: Mapped Profiles
    Read Only: true
    The number of profiles using this resource.
  • Title: Predefined Data
    Default Value: 0
    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.
  • Title: Parent Resource ID
    The unique identifier of the source resource.
  • Title: Source Object Name
    Read Only: true
    The name of the source object resource. For example, the REST resource, the view object name or file name.
  • Title: Use as List of Values
    Maximum Length: 1
    Default Value: false
    Indicates whether a resource can be used as a source for a list of values. The default value is N.
  • Title: Variable Type Code
    Read Only: true
    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.
  • Title: Variable Type
    Read Only: true
    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.
Nested Schema : Artifact Element Relations
Type: array
Title: Artifact Element Relations
The 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 : artifactResources-artifactRelations-item-response
Type: object
Show Source
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 : artifactResources-artifactRelations-artifactElementAttributes-item-response
Type: object
Show Source
Nested Schema : artifactResources-artifactRelations-artifactElementProperties-item-response
Type: object
Show Source
  • Title: Property Description
    Maximum Length: 240
    The description of a data artifact element property.
  • Links
  • Title: Property Code
    Maximum Length: 50
    The data artifact element property unique code, such as FINDERNAME.
  • Title: Property ID
    The unique identifier of an artifact element property.
  • Title: Property Name
    Maximum Length: 50
    The name of a data artifact element property.
  • 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.
  • 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.
  • Title: Property Value
    Maximum Length: 900
    The value of a data artifact element property.
Back to Top