Update a result
patch
/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results/{resultsUniqID}
Request
Path Parameters
-
courseListsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Course Lists resource and used to uniquely identify an instance of Course Lists. The client should not generate the hash key value. Instead, the client should query on the Course Lists collection resource in order to navigate to a specific instance of Course Lists to get the hash key.
-
resultsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Results resource and used to uniquely identify an instance of Results. The client should not generate the hash key value. Instead, the client should query on the Results collection resource in order to navigate to a specific instance of Results 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
-
DefaultResultSetFlag: boolean
Title:
Default Result Set Indicator
Maximum Length:1
Indicates the default result set for a scheduled course or course offering. The default value is false. -
ResultId: integer
(int64)
Title:
Curriculum Result ID
The unique identifier for a curriculum result record. -
ResultSetId: integer
(int64)
Title:
Result Set ID
The unique identifier for a result set. -
ResultTypeId: integer
(int64)
Title:
Result Type ID
The unique identifier for a result type.
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 : courseLists-results-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row for the result. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the result row was created. -
DefaultResultSetFlag: boolean
Title:
Default Result Set Indicator
Maximum Length:1
Indicates the default result set for a scheduled course or course offering. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated By
Read Only:true
The date and time when the result row was last updated. -
LastUpdatedBy: string
Title:
Last Updated Date
Read Only:true
Maximum Length:64
The user who last updated the row for the result. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultId: integer
(int64)
Title:
Curriculum Result ID
The unique identifier for a curriculum result record. -
ResultSetCode: string
Title:
Result Set Code
Read Only:true
Maximum Length:30
The unique code for a result set. -
ResultSetId: integer
(int64)
Title:
Result Set ID
The unique identifier for a result set. -
ResultSetName: string
Title:
Result Set Name
Read Only:true
Maximum Length:50
The name of a result set. -
ResultTypeCode: string
Title:
Result Type Code
Read Only:true
Maximum Length:30
The unique code for a result type. -
ResultTypeId: integer
(int64)
Title:
Result Type ID
The unique identifier for a result type. -
ResultTypeName: string
Title:
Result Type Name
Read Only:true
Maximum Length:50
The name of a result type.
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.