REST API for Oracle Fusion Cloud Student Management

Get a data contract attribute

get

/fscmRestApi/resources/11.13.18.05/hedDataContracts/{DataContractId}/child/attributes/{AttributeId}

Request

Path Parameters

AttributeId(required): integer(int64)

The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
DataContractId(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: string

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: string

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.

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.

Root Schema : hedDataContracts-attributes-item-response

Type: object

Show Source

AttributeAlias: string

Title: Attribute Value

Read Only: true

Maximum Length: 100

The alias of the attribute related to the data contract.
AttributeId: integer (int64)

Title: Attribute ID

Read Only: true

The unique identifier for an attribute of a data contract.
AttributeName: string

Title: Attribute Name

Read Only: true

Maximum Length: 100

The name of the attribute related to the data contract.
AttributeTypeCode: string

Title: Attribute Type Code

Read Only: true

Maximum Length: 30

The type code of an attribute of a data contract. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.
AttributeTypeMeaning: string

Title: Attribute Type Meaning

Read Only: true

Maximum Length: 80

The meaning of the type code of a data contract attribute. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the data contract attribute.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date when the data contract attribute was created.
DefaultValue: string

Title: Default Value

Read Only: true

Maximum Length: 512

Indicates the default value of an attribute in data contract attribute resource.
DefaultValueTypeCode: string

Title: Default Value Type Code

Read Only: true

Maximum Length: 30

Indicates the default value type code of an attribute in data contract attribute resource. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.
DefaultValueTypeMeaning: string

Title: Default Value Type Meaning

Read Only: true

Maximum Length: 80

The meaning of the default value type of a data contract attribute. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.
LastUpdateBy: string

Title: Last Update By

Read Only: true

Maximum Length: 64

The user who last updated the data contract attribute.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

The date and time when the data contract attribute was last updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
RequiredFlag: boolean

Title: Required

Read Only: true

Maximum Length: 1

Default Value: false

Indicates whether the attribute is required. If true, then the attribute is required. If false, then the attribute isn't required.

{
    "type":"object",
    "properties":{
        "AttributeAlias":{
            "title":"Attribute Value",
            "maxLength":100,
            "type":"string",
            "description":"The alias of the attribute related to the data contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"The unique identifier for an attribute of a data contract.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the attribute related to the data contract.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeTypeCode":{
            "title":"Attribute Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type code of an attribute of a data contract. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttributeTypeMeaning":{
            "title":"Attribute Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the type code of a data contract attribute. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the data contract attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the data contract attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":512,
            "type":"string",
            "description":"Indicates the default value of an attribute in data contract attribute resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValueTypeCode":{
            "title":"Default Value Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the default value type code of an attribute in data contract attribute resource. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DefaultValueTypeMeaning":{
            "title":"Default Value Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the default value type of a data contract attribute. A list of acceptable values is defined in the lookup ORA_HEY_ATTRIBUTE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateBy":{
            "title":"Last Update By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the data contract attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the data contract attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute is required. If true, then the attribute is required. If false, then the attribute isn't required.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

heyLookupsAttributeTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

finder: ByLookupTypeFinder%3BLookupCode%3D{AttributeTypeCode}%2CLookupType%3DORA_HEY_ATTRIBUTE_TYPE_CODE

The following properties are defined on the LOV link relation:

Source Attribute: AttributeTypeCode; Target Attribute: LookupCode
Display Attribute: Meaning

heyLookupsDefaultValueTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

finder: ByLookupTypeFinder%3BLookupCode%3D{DefaultValueTypeCode}%2CLookupType%3DORA_HEY_ATTRIBUTE_TYPE_CODE

The following properties are defined on the LOV link relation:

Source Attribute: DefaultValueTypeCode; Target Attribute: LookupCode
Display Attribute: Meaning