Jump to

• Request
• Response

Create a workflow evaluation request

post

/fscmRestApi/resources/11.13.18.05/hedEvaluationRequests

Request

Header Parameters

• Effective-Of: string
  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: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "AssociatedPartyId",
        "StatusSchemeId",
        "WorkflowId",
        "WorkflowName"
    ],
    "type":"object",
    "properties":{
        "AssociatedPartyId":{
            "title":"Associated Party ID",
            "type":"integer",
            "description":"The unique identifier for the person associated with the evaluation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EvaluationRequestId":{
            "title":"Evaluation Request ID",
            "type":"integer",
            "description":"The unique identifier for an evaluation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EvaluationResponse":{
            "title":"Evaluation Responses",
            "type":"array",
            "description":"Use the evaluation response resource to view, create, or modify information regarding evaluation responses.",
            "items":{
                "$ref":"#/components/schemas/hedEvaluationRequests-EvaluationResponse-item-post-request"
            }
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "type":"integer",
            "description":"The unique identifier for the workflow process instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The unique code for the source object of an evaluation request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object of an evaluation request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies a status on a status scheme.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date on which a status was recorded.",
            "format":"date",
            "nullable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier for a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatusSchemeName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status that's part of a status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkflowId":{
            "title":"Workflow ID",
            "type":"integer",
            "description":"The unique identifier for a workflow process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkflowName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of a workflow.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Evaluation Responses",
    "type":"array",
    "description":"Use the evaluation response resource to view, create, or modify information regarding evaluation responses.",
    "items":{
        "$ref":"#/components/schemas/hedEvaluationRequests-EvaluationResponse-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Comment":{
            "title":"Comment",
            "type":"string",
            "description":"A comment made by an evaluator.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "CommentClob"
                ]
            }
        },
        "EvaluationRequestId":{
            "title":"Evaluation Request ID",
            "type":"integer",
            "description":"The unique identifier of the evaluation request that the response is mapped to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EvaluationResponseId":{
            "title":"Evaluation Response ID",
            "type":"integer",
            "description":"The unique identifier for an evaluation response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party who performed an evaluation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies a status of the evaluation response.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date on which the status was recorded for the response.",
            "format":"date",
            "nullable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier for the status scheme mapped to the response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatusSchemeName":{
            "title":"Status Scheme Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses mapped to the response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status that's part of a status scheme, mapped to the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TaskInstanceId":{
            "title":"Task Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the evaluation task assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedEvaluationRequests-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AssociatedPartyId":{
            "title":"Associated Party ID",
            "type":"integer",
            "description":"The unique identifier for the person associated with the evaluation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssociatedPersonName":{
            "title":"Associated Person",
            "maxLength":450,
            "type":"string",
            "description":"The person associated with an evaluation request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The person or entity who created the evaluation request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which an evaluation request is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EvaluationRequestId":{
            "title":"Evaluation Request ID",
            "type":"integer",
            "description":"The unique identifier for an evaluation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EvaluationResponse":{
            "title":"Evaluation Responses",
            "type":"array",
            "description":"Use the evaluation response resource to view, create, or modify information regarding evaluation responses.",
            "items":{
                "$ref":"#/components/schemas/hedEvaluationRequests-EvaluationResponse-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The application displays the date that the record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The application displays the identity of the user who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "type":"integer",
            "description":"The unique identifier for the workflow process instance.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The unique code for the source object of an evaluation request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object of an evaluation request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Source Object",
            "maxLength":80,
            "type":"string",
            "description":"The source object of an evaluation request, such as an admissions application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies a status on a status scheme.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date on which a status was recorded.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier for a status scheme.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status that's part of a status scheme.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkflowId":{
            "title":"Workflow ID",
            "type":"integer",
            "description":"The unique identifier for a workflow process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkflowName":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of a workflow.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object hedEvaluationRequests-EvaluationResponse-item-response

{
    "title":"Evaluation Responses",
    "type":"array",
    "description":"Use the evaluation response resource to view, create, or modify information regarding evaluation responses.",
    "items":{
        "$ref":"#/components/schemas/hedEvaluationRequests-EvaluationResponse-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : hedEvaluationRequests-EvaluationResponse-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Comment":{
            "title":"Comment",
            "type":"string",
            "description":"A comment made by an evaluator.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "CommentClob"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The person or entity who created the response for the evaluation request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the response to the evaluation request is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EvaluationRequestId":{
            "title":"Evaluation Request ID",
            "type":"integer",
            "description":"The unique identifier of the evaluation request that the response is mapped to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EvaluationResponseId":{
            "title":"Evaluation Response ID",
            "type":"integer",
            "description":"The unique identifier for an evaluation response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The application displays the date that the evaluation response record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The application displays the identity of the user who last edited the evaluation response record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier for the party who performed an evaluation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies a status of the evaluation response.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusDate":{
            "title":"Status Date",
            "type":"string",
            "description":"The date on which the status was recorded for the response.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StatusSchemeId":{
            "title":"Status Scheme ID",
            "type":"integer",
            "description":"The unique identifier for the status scheme mapped to the response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusSchemeName":{
            "title":"Status Scheme Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the status scheme, such as admissions statuses mapped to the response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusSchemeStatusId":{
            "title":"Status Scheme Status ID",
            "type":"integer",
            "description":"The unique identifier for a status that's part of a status scheme, mapped to the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task ID",
            "type":"integer",
            "description":"The unique identifier for the task assigned to an evaluator.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Task ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "TaskInstanceId":{
            "title":"Task Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the evaluation task assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a task assigned to an evaluator.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Task Name"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

EvaluationResponse

Operation: /fscmRestApi/resources/11.13.18.05/hedEvaluationRequests/{hedEvaluationRequestsUniqID}/child/EvaluationResponse

Parameters:

• hedEvaluationRequestsUniqID: $request.path.hedEvaluationRequestsUniqID

Use the evaluation response resource to view, create, or modify information regarding evaluation responses.

sourceObjectCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

statusSchemesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes

The following properties are defined on the LOV link relation:

• Source Attribute: StatusSchemeName; Target Attribute: StatusSchemeName
• Display Attribute: StatusSchemeName

statusesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowStatusSchemes

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: StatusCode
• Display Attribute: StatusMeaning

workflowDefinitionsLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedWorkflowDefinitions

The following properties are defined on the LOV link relation:

• Source Attribute: WorkflowName; Target Attribute: WorkflowName
• Display Attribute: WorkflowName

Back to Top