Update a subject
patch
/fscmRestApi/resources/11.13.18.05/subjects/{subjectsUniqID}
Request
Path Parameters
-
subjectsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Drop Scheme Settings Assignments resource and used to uniquely identify an instance of Drop Scheme Settings Assignments. The client should not generate the hash key value. Instead, the client should query on the Drop Scheme Settings Assignments collection resource in order to navigate to a specific instance of Drop Scheme Settings Assignments to get the hash key.
Header Parameters
-
Effective-Of:
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:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicSubjectName: string
Title:
Name
Maximum Length:100
The name of an academic subject. -
assignments: array
Drop Scheme Settings Assignments
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned. -
Description: string
Title:
Description
Maximum Length:1000
The description for an academic subject. -
InstitutionId: integer
(int64)
Title:
Institution
A generated primary key column for an institution. -
IsActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the academic subject is active. -
subjectOwners: array
subjectOwners
-
SubjectStatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_INACTIVE
The status code of the academic subject. A list of accepted values is defined in the lookup type ORA_HER_SUBJECT_STATUS_CODE.
Nested Schema : Drop Scheme Settings Assignments
Type:
array
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodTypeCode: string
Maximum Length:
30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
Nested Schema : schema
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The academic organization that owns the subject. -
AcademicOrgName: string
Title:
Name
Maximum Length:50
The name of an academic organization. -
PercentOwnershipQuantity: number
Title:
Percentage
The percentage of the academic organization ownership.
Response
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 : subjects-item-response
Type:
Show Source
object
-
AcademicSubjectCode: string
Title:
Subject Code
Maximum Length:30
The code for an academic subject. -
AcademicSubjectId: integer
(int64)
Title:
Academic Subject ID
Read Only:true
A generated primary key column for an academic subject. -
AcademicSubjectName: string
Title:
Name
Maximum Length:100
The name of an academic subject. -
assignments: array
Drop Scheme Settings Assignments
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned. -
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
Title:
Description
Maximum Length:1000
The description for an academic subject. -
InstitutionId: integer
(int64)
Title:
Institution
A generated primary key column for an institution. -
IsActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the academic subject is active. -
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. -
subjectOwners: array
subjectOwners
-
SubjectStatus: string
Title:
Subject Status
Read Only:true
Maximum Length:80
The status meaning of the academic subject. -
SubjectStatusCode: string
Title:
Status
Maximum Length:30
Default Value:ORA_INACTIVE
The status code of the academic subject. A list of accepted values is defined in the lookup type ORA_HER_SUBJECT_STATUS_CODE.
Nested Schema : Drop Scheme Settings Assignments
Type:
array
Title:
Drop Scheme Settings Assignments
The assignments resource provides a list of academic entities which have been assigned.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subjects-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntityStatusCode: string
Read Only:
true
Maximum Length:30
The status code of the entity. This controls the availability of the entity for assignments to settings. -
AssignedEntityStatusMeaning: string
Read Only:
true
Maximum Length:80
The status of the entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodMeaning: string
Read Only:
true
Maximum Length:80
The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentMethodTypeCode: string
Maximum Length:
30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
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. -
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. -
RelatedEntityCode: string
Read Only:
true
Maximum Length:100
The user defined identifier of the related entity. -
RelatedEntityId: integer
(int64)
The unique identifier of the related entity.
-
RelatedEntityName: string
Read Only:
true
Maximum Length:100
The name of the related entity. -
RelatedEntityTypeCode: string
Maximum Length:
30
A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
Read Only:
true
Maximum Length:80
The entity type of the related entity. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
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.
Nested Schema : subjects-subjectOwners-item-response
Type:
Show Source
object
-
AcademicOrgId: integer
(int64)
Title:
Academic Organization ID
The academic organization that owns the subject. -
AcademicOrgName: string
Title:
Name
Maximum Length:50
The name of an academic organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PercentOwnershipQuantity: number
Title:
Percentage
The percentage of the academic organization ownership.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assignments
-
Parameters:
- subjectsUniqID:
$request.path.subjectsUniqID
The assignments resource provides a list of academic entities which have been assigned. - subjectsUniqID:
- subjectOwners
-
Parameters:
- subjectsUniqID:
$request.path.subjectsUniqID
The subject owners resource is a child of the subjects resource and provides a list of organizations that own a subject. - subjectsUniqID:
- subjectStatusCodeLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupCode%3D{SubjectStatusCode}%2CLookupType%3DORA_HER_SUBJECT_STATUS
List of values for academic subject status. - finder: