REST API for Oracle Fusion Cloud Student Management

Get a staff assignment

get

/fscmRestApi/resources/11.13.18.05/hedStaffAssignmentsLOV/{hedStaffAssignmentsLOVUniqID}

Request

Path Parameters

hedStaffAssignmentsLOVUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Staff Assignments List of Values resource and used to uniquely identify an instance of Staff Assignments List of Values. The client should not generate the hash key value. Instead, the client should query on the Staff Assignments List of Values collection resource in order to navigate to a specific instance of Staff Assignments List of Values to get the hash key.

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

Effective-Of: string

This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
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 : hedStaffAssignmentsLOV-item-response

Type: object

Show Source

AcademicOrgId: integer (int64)

Title: Academic Organization

Read Only: true

The primary key of the academic organization that the staff member is associated with.
AcademicOrgName: string

Title: Name

Read Only: true

Maximum Length: 50

The name of the academic organization that the staff member is associated with.
CampusId: integer (int64)

Title: Campus

Read Only: true

The primary key of the campus that the staff member is associated with.
CampusName: string

Title: Campus Name

Read Only: true

Maximum Length: 50

The name of the campus that the staff member is associated with.
CatalogNumber: string

Title: Catalog Number

Read Only: true

Maximum Length: 10

The curriculum catalog number that the staff member is associated with.
EndDate: string (date)

Title: Status End

Read Only: true

The date when the assignment ends.
InstitutionId: integer (int64)

Title: Institution

Read Only: true

The primary key of the institution that the staff member is associated with.
InstitutionName: string

Title: Name

Read Only: true

Maximum Length: 50

The name of the institution that the staff member is associated with.
links: array Links

Title: Links

The link relations associated with the resource instance.
PartyId: integer (int64)

Title: Party ID

Read Only: true

The unique identifier for the staff.
PreferredFullName: string

Title: Preferred Name

Read Only: true

Maximum Length: 255

The preferred first and last name of the person displayed as a single string.
RoleStatusCode: string

Title: Status

Read Only: true

Maximum Length: 30

The status code of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_STATUS_CODE.
RoleStatusMeaning: string

Title: Role Status

Read Only: true

Maximum Length: 80

The status code meaning of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_STATUS_CODE.
RoleTypeCode: string

Title: Role

Read Only: true

Maximum Length: 30

The role type code of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
RoleTypeMeaning: string

Title: Role Meaning

Read Only: true

Maximum Length: 80

The role type code meaning for the staff. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.
StaffAssignmentId: integer (int64)

Title: Staff Assignment ID

Read Only: true

The unique identifier of the staff assignment.
StaffConflictFlag: boolean

Title: Staff Conflict

Read Only: true

Maximum Length: 1

Indicates whether this staff member has a conflict between their meetings.
StartDate: string (date)

Title: Status Start

Read Only: true

The date when the assignment starts.
SubjectCode: string

Title: Subject Code

Read Only: true

Maximum Length: 30

The code of the subject that the staff member is associated with.
SubjectId: integer (int64)

Title: Subject

Read Only: true

The primary key of the subject that the staff member is associated with.
SubjectName: string

Title: Subject Name

Read Only: true

Maximum Length: 50

The name of the subject that the staff member is associated with.

{
    "type":"object",
    "properties":{
        "RoleStatusMeaning":{
            "title":"Role Status",
            "maxLength":80,
            "type":"string",
            "description":"The status code meaning of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StaffConflictFlag":{
            "title":"Staff Conflict",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this staff member has a conflict between their meetings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the institution that the staff member is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgId":{
            "title":"Academic Organization",
            "type":"integer",
            "description":"The primary key of the academic organization that the staff member is associated with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution",
            "type":"integer",
            "description":"The primary key of the institution that the staff member is associated with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubjectName":{
            "title":"Subject Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the subject that the staff member is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the academic organization that the staff member is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the campus that the staff member is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Status End",
            "type":"string",
            "description":"The date when the assignment ends.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Status Start",
            "type":"string",
            "description":"The date when the assignment starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogNumber":{
            "title":"Catalog Number",
            "maxLength":10,
            "type":"string",
            "description":"The curriculum catalog number that the staff member is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleTypeCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The role type code of the staff member. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the staff.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubjectCode":{
            "title":"Subject Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the subject that the staff member is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleTypeMeaning":{
            "title":"Role Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The role type code meaning for the staff. A list of accepted values is defined in the lookup type ORA_HER_STAFF_ROLE_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus",
            "type":"integer",
            "description":"The primary key of the campus that the staff member is associated with.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StaffAssignmentId":{
            "title":"Staff Assignment ID",
            "type":"integer",
            "description":"The unique identifier of the staff assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredFullName":{
            "title":"Preferred Name",
            "maxLength":255,
            "type":"string",
            "description":"The preferred first and last name of the person displayed as a single string.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyName",
                    "PreferredName"
                ]
            },
            "x-queryable":true
        },
        "SubjectId":{
            "title":"Subject",
            "type":"integer",
            "description":"The primary key of the subject that the staff member is associated with.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}