Jump to

• Request
• Response

Get an artifact resource

get

/fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}

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=

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 Top

Response

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.

Body ()

Root Schema : artifactResources-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Status

  Maximum Length: 1

  Default Value: true

  Indicates whether a resource is active or inactive. The default value is Y.
• ArtifactCode: string
  Title: Code

  Maximum Length: 50

  The data artifact unique code, such as ACADSTRUCTURERESOURCES.
• ArtifactId: integer (int64)
  Title: Artifact ID

  The unique identifier of an artifact resource.
• ArtifactName: string
  Title: Name

  Maximum Length: 50

  The name of a data resource.
• artifactRelations: array 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.
• ArtifactTypeCode: string
  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.
• ArtifactTypeMeaning: string
  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.
• DataTypeCode: string
  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.
• DataTypeMeaning: string
  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.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of a data resource.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The person who updated the resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappedCategories: integer
  Title: Mapped Categories

  Read Only: true

  The number of categories mapped to this resource.
• MappedDataContracts: integer
  Title: Mapped Data Contracts

  Read Only: true

  The number of data contracts using this variable.
• MappedProfiles: integer
  Title: Mapped Profiles

  Read Only: true

  The number of profiles using this resource.
• SeedDataLock: integer (int32)
  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.
• SourceArtifactId: integer (int64)
  Title: Parent Resource ID

  The unique identifier of the source resource.
• SourceObjectName: string
  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.
• UseAsLovFlag: boolean
  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.
• VariableTypeCode: string
  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.
• VariableTypeMeaning: string
  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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The person who updated the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactTypeMeaning":{
            "title":"Resource Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the artifact type code. A list of accepted values is defined in the lookup type ORA_HEY_ARTIFACT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a data resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ArtifactId":{
            "title":"Artifact ID",
            "type":"integer",
            "description":"The unique identifier of an artifact resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Predefined Data",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "VariableTypeMeaning":{
            "title":"Variable Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MappedDataContracts":{
            "title":"Mapped Data Contracts",
            "type":"integer",
            "description":"The number of data contracts using this variable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a data resource.",
            "nullable":false,
            "x-queryable":true
        },
        "artifactRelations":{
            "title":"Artifact Element Relations",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/artifactResources-artifactRelations-item-response"
            }
        },
        "MappedCategories":{
            "title":"Mapped Categories",
            "type":"integer",
            "description":"The number of categories mapped to this resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactCode":{
            "title":"Code",
            "maxLength":"50",
            "type":"string",
            "description":"The data artifact unique code, such as ACADSTRUCTURERESOURCES.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a resource is active or inactive. The default value is Y.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "MappedProfiles":{
            "title":"Mapped Profiles",
            "type":"integer",
            "description":"The number of profiles using this resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactTypeCode":{
            "title":"Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "type":"string",
            "description":"The name of the source object resource. For example, the REST resource, the view object name or file name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceArtifactId":{
            "title":"Parent Resource ID",
            "type":"integer",
            "description":"The unique identifier of the source resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "title":"Data Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UseAsLovFlag":{
            "title":"Use as List of Values",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a resource can be used as a source for a list of values. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "VariableTypeCode":{
            "title":"Variable Type Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataTypeCode":{
            "title":"Data Type Code",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object artifactResources-artifactRelations-item-response

{
    "title":"Artifact Element Relations",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/artifactResources-artifactRelations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : artifactResources-artifactRelations-item-response

Type: object

Show Source

• 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.
• ArtifactLevel: integer (int32)
  Title: Artifact Level

  The level of the element in hierarchy.
• ArtifactRelationId: integer (int64)
  Title: Artifact Relation ID

  The unique identifier of an artifact relation.
• ArtifactSequence: integer (int32)
  Title: Artifact Sequence

  The sequence number of the element in hierarchy.
• ElementCode: string
  Title: Element Code

  Read Only: true

  Maximum Length: 50

  The data artifact element unique code, such as ACADSTRUCTUREREST.
• ElementDescription: string
  Title: Element Description

  Read Only: true

  Maximum Length: 240

  The description of the data artifact element.
• ElementId: integer (int64)
  Title: Element ID

  The unique identifier of an artifact element.
• ElementName: string
  Title: Element Name

  Read Only: true

  Maximum Length: 50

  The name of the data artifact element.
• ElementSourcePath: string
  Title: Source Path

  Read Only: true

  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.
• ElementTypeCode: string
  Title: Element Type Code

  Read Only: true

  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.
• 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

  Read Only: true

  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.
• ParentRelationSequence: integer (int64)
  Title: Parent Relation Sequence

  The sequence number of the parent element.
• RelationSequence: integer (int64)
  Title: Relation Sequence

  The sequence number of the element.
• SourceObjectName: string
  Title: Source Object Name

  Read Only: true

  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 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.

{
    "type":"object",
    "properties":{
        "ArtifactLevel":{
            "title":"Artifact Level",
            "type":"integer",
            "description":"The level of the element in hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ElementCode":{
            "title":"Element Code",
            "maxLength":"50",
            "type":"string",
            "description":"The data artifact element unique code, such as ACADSTRUCTUREREST.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactRelationId":{
            "title":"Artifact Relation ID",
            "type":"integer",
            "description":"The unique identifier of an artifact relation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HTTPActionCodes":{
            "title":"Action Codes",
            "maxLength":"512",
            "type":"string",
            "description":"The concatenated list of valid HTTP actions of a data artifact element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationSequence":{
            "title":"Relation Sequence",
            "type":"integer",
            "description":"The sequence number of the element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ElementTypeMeaning":{
            "title":"Element Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the data artifact element type code. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ArtifactSequence":{
            "title":"Artifact Sequence",
            "type":"integer",
            "description":"The sequence number of the element in hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "artifactElementAttributes":{
            "title":"Artifact Element Attributes",
            "type":"array",
            "description":"The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.",
            "items":{
                "$ref":"#/components/schemas/artifactResources-artifactRelations-artifactElementAttributes-item-response"
            }
        },
        "ParentRelationSequence":{
            "title":"Parent Relation Sequence",
            "type":"integer",
            "description":"The sequence number of the parent element.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourcePath":{
            "title":"Source Path",
            "maxLength":"500",
            "type":"string",
            "description":"The 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.",
            "nullable":true,
            "x-queryable":true
        },
        "artifactElementProperties":{
            "title":"Artifact Element Properties",
            "type":"array",
            "description":"The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.",
            "items":{
                "$ref":"#/components/schemas/artifactResources-artifactRelations-artifactElementProperties-item-response"
            }
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementName":{
            "title":"Element Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the data artifact element.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementSourcePath":{
            "title":"Source Path",
            "maxLength":"500",
            "type":"string",
            "description":"The source path of the element. For example, in case of a view object, this attribute represents the location of this object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ElementTypeCode":{
            "title":"Element Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ElementId":{
            "title":"Element ID",
            "type":"integer",
            "description":"The unique identifier of an artifact element.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ElementDescription":{
            "title":"Element Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the data artifact element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object artifactResources-artifactRelations-artifactElementAttributes-item-response

{
    "title":"Artifact Element Attributes",
    "type":"array",
    "description":"The resource is used to view data artifact element attributes. The attributes could be, for example, curriculum ID and curriculum name.",
    "items":{
        "$ref":"#/components/schemas/artifactResources-artifactRelations-artifactElementAttributes-item-response"
    }
}

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

• Array of: object artifactResources-artifactRelations-artifactElementProperties-item-response

{
    "title":"Artifact Element Properties",
    "type":"array",
    "description":"The resource is used to view data artifact element properties. The properties could be, for example, finders and actions.",
    "items":{
        "$ref":"#/components/schemas/artifactResources-artifactRelations-artifactElementProperties-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : artifactResources-artifactRelations-artifactElementAttributes-item-response

Type: object

Show Source

• 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 value of an element attribute when compared to another 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's 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 multicolumn 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.

{
    "type":"object",
    "properties":{
        "LovSourceResourceName":{
            "title":"List of Values Source Resource Name",
            "maxLength":"200",
            "type":"string",
            "description":"The source resource name for the list of values resource of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Attribute Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a data artifact element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumInRange":{
            "title":"Minimum Value",
            "type":"integer",
            "description":"The minimum value of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"The unique identifier of an artifact element attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LookupTypeCode":{
            "title":"List of Values Lookup Type",
            "maxLength":"30",
            "type":"string",
            "description":"The list of values lookup type of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentAttributeIdTwo":{
            "title":"Parent Attribute 2 ID",
            "type":"integer",
            "description":"The parent attribute 2 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LovDisplayFields":{
            "title":"List of Values Display Fields",
            "maxLength":"900",
            "type":"string",
            "description":"The comma separated field names of the list of values resource associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "TranslatableFlag":{
            "title":"Translatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is translatable or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDataTypeCode":{
            "title":"Data Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LovDisplayFieldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this attribute acts as the display field of this list of values resource element. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AttributeCodeAlias":{
            "title":"Attribute Alias",
            "maxLength":"500",
            "type":"string",
            "description":"The alias name of the element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "FinderAttributeNameOne":{
            "title":"Finder 1 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 1 of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":"512",
            "type":"string",
            "description":"The default value of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LovValueField":{
            "title":"List of Values Field",
            "maxLength":"900",
            "type":"string",
            "description":"The field name of the list of values resource associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QueryableFlag":{
            "title":"Can Be Queried",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute can be queried or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LovValueFieldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this attribute acts as the value field of this list of values resource element. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AvlblToQueryFilterFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this attribute is available for filtering query data in the data selection tool. The default value is Y.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LovFinderName":{
            "title":"List of Values Finder Name",
            "maxLength":"512",
            "type":"string",
            "description":"The list of values finder name of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableToRulesUIFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this attribute is available for use in the rules framework. The default value is Y.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AllowLovMultipleFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CascdLovValueFieldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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's selected for career field.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AllowLovAllFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the value All appears in the list of values for the association criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the data artifact element attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeTypeMeaning":{
            "title":"Data Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the element attribute data type code. A list of accepted values is defined in the lookup type ORA_HEY_ATTRIBUTE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeSequence":{
            "title":"Attribute Sequence",
            "type":"integer",
            "description":"The sequence of the attribute in the element.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "MaximumInRange":{
            "title":"Maximum Value",
            "type":"integer",
            "description":"The maximum value of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAttributeIdThree":{
            "title":"Parent Attribute 3 ID",
            "type":"integer",
            "description":"The parent attribute 3 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LovArtifactId":{
            "title":"List of Values Resource ID",
            "type":"integer",
            "description":"The list of values resource ID of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeWeight":{
            "title":"Weight",
            "type":"number",
            "description":"The value of an element attribute when compared to another element attribute.",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "scale":"4"
            },
            "x-queryable":true
        },
        "ParentAttributeIdFour":{
            "title":"Parent Attribute 4 ID",
            "type":"integer",
            "description":"The parent attribute 4 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DefaultValueJSON":{
            "type":"string",
            "description":"Default value of the attribute in JSON format. Used by list or multicolumn list variables.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ParentAttributeIdFive":{
            "title":"Parent Attribute 5 ID",
            "type":"integer",
            "description":"The parent attribute 5 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAttributeIdOne":{
            "title":"Parent Attribute 1 ID",
            "type":"integer",
            "description":"The parent attribute 1 of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameFour":{
            "title":"Finder 4 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 4 of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeLength":{
            "title":"Attribute Length",
            "type":"integer",
            "description":"The length of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameThree":{
            "title":"Finder 3 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 3 of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Code",
            "maxLength":"50",
            "type":"string",
            "description":"The data artifact element attribute unique code, such as Course ID.",
            "nullable":false,
            "x-queryable":true
        },
        "QueryParameterFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute can be queried in REST.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "maxLength":"200",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdatableFlag":{
            "title":"Updatable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is updatable or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowChangesTypeCode":{
            "title":"Allow Changes",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates when an element attribute is updatable.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an element attribute is required or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDecimalPlaces":{
            "title":"Decimal Places",
            "type":"integer",
            "description":"The precision of an element attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FinderAttributeNameFive":{
            "title":"Finder 5 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 5 of an element attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AvlblToQueryJoinFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that this attribute is available for joining query tables in the data selection tool. The default value is Y.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "PrimaryObjectFlag":{
            "title":"Primary Object",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates when an element attribute is primary.",
            "nullable":true,
            "x-queryable":true
        },
        "FinderAttributeNameTwo":{
            "title":"Finder 2 Name",
            "maxLength":"512",
            "type":"string",
            "description":"The finder name 2 of an element attribute.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : artifactResources-artifactRelations-artifactElementProperties-item-response

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "PropertyName":{
            "title":"Property Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a data artifact element property.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Property Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a data artifact element property.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":"900",
            "type":"string",
            "description":"The value of a data artifact element property.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PropertyTypeMeaning":{
            "title":"Property Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the element property type code. A list of accepted values is defined in the lookup type ORA_HEY_ELEMENT_PROPERTY_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCode":{
            "title":"Property Code",
            "maxLength":"50",
            "type":"string",
            "description":"The data artifact element property unique code, such as FINDERNAME.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyId":{
            "title":"Property ID",
            "type":"integer",
            "description":"The unique identifier of an artifact element property.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

HeyCommonServiceAM_HeyLookup1_1

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_ARTIFACT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: ArtifactTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

HeyCommonServiceAM_HeyLookup1_2

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_ELEMENT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: VariableTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

HeyCommonServiceAM_HeyLookup1_3

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_ATTRIBUTE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: DataTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

artifactRelations

Operation: /fscmRestApi/resources/11.13.18.05/artifactResources/{ArtifactId}/child/artifactRelations

Parameters:

• ArtifactId: $request.path.ArtifactId

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.

Back to Top