Jump to

• Request
• Response

Create a record evaluation result

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordEvaluationResults

Request

Header Parameters

• 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

• AiAgent: string
  Maximum Length: 1

  The flag used to determine whether the record evaluation result was generated by an AI agent.
• Classification: string
  Maximum Length: 3

  The classification code of the associated record.
• EvalDate: string (date-time)
  The date time that the record evaluation result was created.
• EvalResult: string (byte)
  The result of the record evaluation.
• EvalStatus: string
  Maximum Length: 30

  The status of the record evaluation.
• EvalType: string
  Maximum Length: 50

  The type of the record evaluation.
• RecordId: string
  Maximum Length: 50

  The record id associated with the record being evaluated.
• RecordKey: integer (int64)
  The unique identifier of the associated record being evaluated.
• ResultKey: integer (int64)
  The unique identifier of the record evaluation result.
• UserDefinedChar01: string
  Maximum Length: 1500

  A field that is used for storing additional information pertaining to the record evaluation.
• UserDefinedDate01: string (date-time)
  A field that is used for storing additional information pertaining to the record evaluation.
• UserDefinedNumber01: number
  A field that is used for storing additional information pertaining to the record evaluation.

{
    "type":"object",
    "properties":{
        "AiAgent":{
            "maxLength":1,
            "type":"string",
            "description":"The flag used to determine whether the record evaluation result was generated by an AI agent.",
            "nullable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification code of the associated record.",
            "nullable":false
        },
        "EvalDate":{
            "type":"string",
            "description":"The date time that the record evaluation result was created.",
            "format":"date-time",
            "nullable":true
        },
        "EvalResult":{
            "type":"string",
            "description":"The result of the record evaluation.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "EvalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the record evaluation.",
            "nullable":true
        },
        "EvalType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of the record evaluation.",
            "nullable":false
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The record id associated with the record being evaluated.",
            "nullable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the associated record being evaluated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResultKey":{
            "type":"integer",
            "description":"The unique identifier of the record evaluation result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UserDefinedChar01":{
            "maxLength":1500,
            "type":"string",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "nullable":true
        },
        "UserDefinedDate01":{
            "type":"string",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "format":"date-time",
            "nullable":true
        },
        "UserDefinedNumber01":{
            "type":"number",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "nullable":true
        }
    }
}

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 : publicSectorRecordEvaluationResults-item-response

Type: object

Show Source

• AiAgent: string
  Maximum Length: 1

  The flag used to determine whether the record evaluation result was generated by an AI agent.
• Classification: string
  Maximum Length: 3

  The classification code of the associated record.
• EvalDate: string (date-time)
  The date time that the record evaluation result was created.
• EvalResult: string (byte)
  The result of the record evaluation.
• EvalStatus: string
  Maximum Length: 30

  The status of the record evaluation.
• EvalType: string
  Maximum Length: 50

  The type of the record evaluation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordId: string
  Maximum Length: 50

  The record id associated with the record being evaluated.
• RecordKey: integer (int64)
  The unique identifier of the associated record being evaluated.
• ResultKey: integer (int64)
  The unique identifier of the record evaluation result.
• UserDefinedChar01: string
  Maximum Length: 1500

  A field that is used for storing additional information pertaining to the record evaluation.
• UserDefinedDate01: string (date-time)
  A field that is used for storing additional information pertaining to the record evaluation.
• UserDefinedNumber01: number
  A field that is used for storing additional information pertaining to the record evaluation.

{
    "type":"object",
    "properties":{
        "AiAgent":{
            "maxLength":1,
            "type":"string",
            "description":"The flag used to determine whether the record evaluation result was generated by an AI agent.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification code of the associated record.",
            "nullable":false,
            "x-queryable":true
        },
        "EvalDate":{
            "type":"string",
            "description":"The date time that the record evaluation result was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EvalResult":{
            "type":"string",
            "description":"The result of the record evaluation.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "EvalStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the record evaluation.",
            "nullable":true,
            "x-queryable":true
        },
        "EvalType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of the record evaluation.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The record id associated with the record being evaluated.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the associated record being evaluated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultKey":{
            "type":"integer",
            "description":"The unique identifier of the record evaluation result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UserDefinedChar01":{
            "maxLength":1500,
            "type":"string",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedDate01":{
            "type":"string",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedNumber01":{
            "type":"number",
            "description":"A field that is used for storing additional information pertaining to the record evaluation.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top