Create a workflow evaluation request
post
/fscmRestApi/resources/11.13.18.05/hedEvaluationRequests
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssociatedPartyId(required): integer
(int64)
Title:
Associated Party ID
The unique identifier for the person associated with the evaluation request. -
EvaluationRequestId: integer
(int64)
Title:
Evaluation Request ID
The unique identifier for an evaluation request. -
EvaluationResponse: array
Evaluation Responses
Title:
Evaluation Responses
Use the evaluation response resource to view, create, or modify information regarding evaluation responses. -
ProcessInstanceId: integer
(int64)
Title:
Process Instance ID
The unique identifier for the workflow process instance. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:128
The unique code for the source object of an evaluation request. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object of an evaluation request. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The unique code that identifies a status on a status scheme. -
StatusDate: string
(date)
Title:
Status Date
The date on which a status was recorded. -
StatusSchemeId(required): integer
(int64)
Title:
Status Scheme ID
The unique identifier for a status scheme. -
StatusSchemeName: string
Title:
Name
Maximum Length:60
The name of the status scheme, such as admissions statuses. -
StatusSchemeStatusId: integer
(int64)
Title:
Status Scheme Status ID
The unique identifier for a status that's part of a status scheme. -
WorkflowId(required): integer
(int64)
Title:
Workflow ID
The unique identifier for a workflow process. -
WorkflowName(required): string
Title:
Name
Maximum Length:60
The name of a workflow.
Nested Schema : Evaluation Responses
Type:
array
Title:
Evaluation Responses
Use the evaluation response resource to view, create, or modify information regarding evaluation responses.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Comment: string
Title:
Comment
A comment made by an evaluator. -
EvaluationRequestId: integer
(int64)
Title:
Evaluation Request ID
The unique identifier of the evaluation request that the response is mapped to. -
EvaluationResponseId: integer
(int64)
Title:
Evaluation Response ID
The unique identifier for an evaluation response. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier for the party who performed an evaluation. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The unique code that identifies a status of the evaluation response. -
StatusDate: string
(date)
Title:
Status Date
The date on which the status was recorded for the response. -
StatusSchemeId: integer
(int64)
Title:
Status Scheme ID
The unique identifier for the status scheme mapped to the response. -
StatusSchemeName: string
Title:
Status Scheme Name
Maximum Length:60
The name of the status scheme, such as admissions statuses mapped to the response. -
StatusSchemeStatusId: integer
(int64)
Title:
Status Scheme Status ID
The unique identifier for a status that's part of a status scheme, mapped to the response. -
TaskInstanceId: integer
(int64)
Title:
Task Assignment ID
The unique identifier for the evaluation task assignment.
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 : hedEvaluationRequests-item-response
Type:
Show Source
object
-
AssociatedPartyId: integer
(int64)
Title:
Associated Party ID
The unique identifier for the person associated with the evaluation request. -
AssociatedPersonName: string
Title:
Associated Person
Read Only:true
Maximum Length:450
The person associated with an evaluation request. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person or entity who created the evaluation request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which an evaluation request is created. -
EvaluationRequestId: integer
(int64)
Title:
Evaluation Request ID
The unique identifier for an evaluation request. -
EvaluationResponse: array
Evaluation Responses
Title:
Evaluation Responses
Use the evaluation response resource to view, create, or modify information regarding evaluation responses. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The application displays the date that the record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The application displays the identity of the user who last edited the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProcessInstanceId: integer
(int64)
Title:
Process Instance ID
The unique identifier for the workflow process instance. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:128
The unique code for the source object of an evaluation request. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier for the source object of an evaluation request. -
SourceObjectMeaning: string
Title:
Source Object
Read Only:true
Maximum Length:80
The source object of an evaluation request, such as an admissions application. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The unique code that identifies a status on a status scheme. -
StatusDate: string
(date)
Title:
Status Date
The date on which a status was recorded. -
StatusSchemeId: integer
(int64)
Title:
Status Scheme ID
The unique identifier for a status scheme. -
StatusSchemeName: string
Title:
Name
Maximum Length:60
The name of the status scheme, such as admissions statuses. -
StatusSchemeStatusId: integer
(int64)
Title:
Status Scheme Status ID
The unique identifier for a status that's part of a status scheme. -
WorkflowId: integer
(int64)
Title:
Workflow ID
The unique identifier for a workflow process. -
WorkflowName: string
Title:
Name
Maximum Length:60
The name of a workflow.
Nested Schema : Evaluation Responses
Type:
array
Title:
Evaluation Responses
Use the evaluation response resource to view, create, or modify information regarding evaluation responses.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedEvaluationRequests-EvaluationResponse-item-response
Type:
Show Source
object
-
Comment: string
Title:
Comment
A comment made by an evaluator. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The person or entity who created the response for the evaluation request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the response to the evaluation request is created. -
EvaluationRequestId: integer
(int64)
Title:
Evaluation Request ID
The unique identifier of the evaluation request that the response is mapped to. -
EvaluationResponseId: integer
(int64)
Title:
Evaluation Response ID
The unique identifier for an evaluation response. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The application displays the date that the evaluation response record was last edited. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The application displays the identity of the user who last edited the evaluation response record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier for the party who performed an evaluation. -
StatusCode: string
Title:
Status Code
Maximum Length:30
The unique code that identifies a status of the evaluation response. -
StatusDate: string
(date)
Title:
Status Date
The date on which the status was recorded for the response. -
StatusSchemeId: integer
(int64)
Title:
Status Scheme ID
The unique identifier for the status scheme mapped to the response. -
StatusSchemeName: string
Title:
Status Scheme Name
Maximum Length:60
The name of the status scheme, such as admissions statuses mapped to the response. -
StatusSchemeStatusId: integer
(int64)
Title:
Status Scheme Status ID
The unique identifier for a status that's part of a status scheme, mapped to the response. -
TaskId: integer
(int64)
Title:
Task ID
Read Only:true
The unique identifier for the task assigned to an evaluator. -
TaskInstanceId: integer
(int64)
Title:
Task Assignment ID
The unique identifier for the evaluation task assignment. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:50
The name of a task assigned to an evaluator.
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
- EvaluationResponse
-
Parameters:
- hedEvaluationRequestsUniqID:
$request.path.hedEvaluationRequestsUniqID
Use the evaluation response resource to view, create, or modify information regarding evaluation responses. - hedEvaluationRequestsUniqID:
- sourceObjectCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_EVAL_SOURCE_OBJECT
The following properties are defined on the LOV link relation:- Source Attribute: SourceObjectCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- statusSchemesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: StatusSchemeName; Target Attribute: StatusSchemeName
- Display Attribute: StatusSchemeName
- statusesLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: StatusCode; Target Attribute: StatusCode
- Display Attribute: StatusMeaning
- workflowDefinitionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: WorkflowName; Target Attribute: WorkflowName
- Display Attribute: WorkflowName