Update a status scheme
patch
/fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}
Request
Path Parameters
-
StatusSchemeId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the status scheme is active or inactive. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier of the category associated with the status scheme. -
CategoryName: string
Title:
Category
Maximum Length:50
The name of the associated category. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier of the institution associated with the status scheme. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The name of the associated institution. -
statuses: array
Statuses
Title:
Statuses
The statuses resource is used to view, create, or modify statuses in a status scheme. -
StatusSchemeCode: string
Title:
Status Scheme Code
Maximum Length:30
The status scheme code, such as a code for a group of statuses for admissions. -
StatusSchemeDescription: string
Title:
Description
Maximum Length:240
The description for the status scheme, such as a description for admissions statuses. -
StatusSchemeName: string
Title:
Name
Maximum Length:60
The name of the status scheme, such as admissions statuses.
Nested Schema : Statuses
Type:
array
Title:
Statuses
The statuses resource is used to view, create, or modify statuses in a status scheme.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
DefaultFlag: boolean
Maximum Length:
1
Indicates whether the status scheme status is the default value. -
DisplayOrder: integer
(int32)
Title:
Display Order
Display order of statuses in the status scheme. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS. -
StatusTypeCode: string
Title:
Status Type Code
Maximum Length:30
The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_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 : hedWorkflowStatusSchemes-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the status scheme is active or inactive. -
CategoryId: integer
(int64)
Title:
Category ID
The unique identifier of the category associated with the status scheme. -
CategoryName: string
Title:
Category
Maximum Length:50
The name of the associated category. -
InstitutionId: integer
(int64)
Title:
Institution ID
The unique identifier of the institution associated with the status scheme. -
InstitutionName: string
Title:
Institution
Maximum Length:50
The name of the associated institution. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which a status scheme was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Indicates who last updated a status scheme. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Title:
Predefined Data
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated. -
statuses: array
Statuses
Title:
Statuses
The statuses resource is used to view, create, or modify statuses in a status scheme. -
StatusSchemeCode: string
Title:
Status Scheme Code
Maximum Length:30
The status scheme code, such as a code for a group of statuses for admissions. -
StatusSchemeDescription: string
Title:
Description
Maximum Length:240
The description for the status scheme, such as a description for admissions statuses. -
StatusSchemeId: integer
(int64)
Title:
Status Scheme ID
The unique identifier of a status scheme. -
StatusSchemeName: string
Title:
Name
Maximum Length:60
The name of the status scheme, such as admissions statuses.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Statuses
Type:
array
Title:
Statuses
The statuses resource is used to view, create, or modify statuses in a status scheme.
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 : hedWorkflowStatusSchemes-statuses-item-response
Type:
Show Source
object
-
DefaultFlag: boolean
Maximum Length:
1
Indicates whether the status scheme status is the default value. -
DisplayOrder: integer
(int32)
Title:
Display Order
Display order of statuses in the status scheme. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The code for a status code. A list of accepted values is defined in the lookup type ORA_HEY_STATUS. -
StatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The meaning of the status code, such as admitted or withdrawn. A list of accepted values is defined in the lookup type ORA_HEY_STATUS. -
StatusSchemeStatusId: integer
(int64)
Title:
Status Scheme Status ID
The unique identifier for a status in a status scheme. -
StatusTypeCode: string
Title:
Status Type Code
Maximum Length:30
The code for a status type. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE. -
StatusTypeMeaning: string
Title:
Status Type
Read Only:true
Maximum Length:80
The meaning of the status type code, such as in progress or completed. A list of accepted values is defined in the lookup type ORA_HEY_STATUS_TYPE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- academicInstitutionsLOV
-
The list of values for the institution associated with the status scheme.
- statuses
-
Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes/{StatusSchemeId}/child/statusesParameters:
- StatusSchemeId:
$request.path.StatusSchemeId
The statuses resource is used to view, create, or modify statuses in a status scheme. - StatusSchemeId:
- studentManagementCategoriesLOV
-
The list of values for the category associated with the status scheme.