Get an academic entity
get
/fscmRestApi/resources/11.13.18.05/academicEntities/{EntityId}
Request
Path Parameters
-
EntityId(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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : academicEntities-item-response
Type:
Show Source
object
-
associatedEntities: array
Associated Academic Entities
Title:
Associated Academic Entities
The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities. -
Description: string
Read Only:
true
Maximum Length:1000
The description of the entity. -
EntityCode: string
Read Only:
true
Maximum Length:100
The user defined static identifier of the entity. -
EntityId: integer
(int64)
Read Only:
true
The unique identifier of the entity. -
EntityName: string
Read Only:
true
Maximum Length:100
The name of the entity. -
EntityStatusCode: string
Read Only:
true
Maximum Length:30
The entity status code of the entity. -
EntityStatusMeaning: string
Read Only:
true
Maximum Length:80
The entity status meaning. -
EntitySubTypeCode: string
Read Only:
true
Maximum Length:30
The entity subtype code of the associated entity. -
EntitySubTypeMeaning: string
Read Only:
true
Maximum Length:80
The entity subtype of the associated entity. -
EntityTypeCode: string
Read Only:
true
Maximum Length:21
The entity type code of the entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
EntityTypeMeaning: string
Read Only:
true
Maximum Length:80
The entity type meaning. -
IsTopLevelEntityFlag: boolean
Read Only:
true
Indicates the entity isn't a child of any entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WaitlistAssignmentMethod: string
Read Only:
true
Maximum Length:80
The method of the settings assignment. -
WaitlistAssignmentMethodCode: string
Read Only:
true
Maximum Length:30
The method code of the settings assignment. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
WaitlistSettingsId: integer
(int64)
Read Only:
true
The physical identifier of the associated waitlist settings.
Nested Schema : Associated Academic Entities
Type:
array
Title:
Associated Academic Entities
The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : academicEntities-associatedEntities-item-response
Type:
Show Source
object
-
AssociatedEntityCode: string
Read Only:
true
The user defined identifier of the associated entity. -
AssociatedEntityId: integer
The unique identifier of the associated entity.
-
AssociatedEntityName: string
Read Only:
true
The name of the associated entity. -
AssociatedEntityStatusCode: string
Read Only:
true
The status code of the system office. This controls the availability of the system office for associations with other academic entities. -
AssociatedEntityStatusMeaning: string
Read Only:
true
Maximum Length:255
The status of the system office. -
AssociatedEntitySubTypeCode: string
Read Only:
true
The entity subtype code of the associated entity. -
AssociatedEntitySubTypeMeaning: string
Read Only:
true
The entity subtype of the associated entity. -
AssociatedEntityTypeCode: string
The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
-
AssociatedEntityTypeMeaning: string
Read Only:
true
The entity type of the associated entity. -
AssociationEndDate: string
(date)
The end or expiration date of the entity association.
-
AssociationStartDate: string
(date)
The start date of the entity association.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date the row was created. -
Description: string
Read Only:
true
The description of the associated entity. -
EntityAssociationId: integer
(int64)
The unique identifier for the entity association record.
-
EntityRelationshipMeaning: string
Read Only:
true
The type of relationship the association represents. -
EntityRelationshipType: string
The code value for the relationship type.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- associatedEntities
-
Parameters:
- EntityId:
$request.path.EntityId
The associated entities resource is used to list and manage the associated academic entities which document the parent and child relationships of academic entities. - EntityId: