Jump to

• Request
• Response

Create a set of records to cache output of AI agents

post

/fscmRestApi/resources/11.13.18.05/publicSectorAiAgentResults

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

• AgencyId: integer (int32)
  Default Value: 1

  The column used to indicate the agency identifier.
• AiAgentName: string
  Maximum Length: 128

  The AI agent team identifier.
• ConfidenceScore: number
  The confidence score of the AI agent result.
• Content: string (byte)
  The result returned by the AI agent.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• QueryName: string
  Maximum Length: 50

  The name given for a query against the AI agent.
• ResultId: integer (int64)
  The result identifier of an AI agent result, indicating primary key of the table.
• Status: string
  Maximum Length: 15

  Default Value: 'Open'

  The status of the query result against the AI agent.
• TransactionType: string
  Maximum Length: 30

  The type of transaction in the AI agent result. For example, possible values are INSP, PMT, BL, PNZ, INC, CE, NOTICE, PAYMENT, and so on.
• TransId: string
  Maximum Length: 50

  The application ID of the transaction record.
• TransKey: integer (int64)
  The primary key of the transaction record.
• UserDefinedDate1: string (date-time)
  The user-defined column for date.
• UserDefinedNumber1: number
  The user-defined column for numbers.
• UserDefinedVarchar: string
  Maximum Length: 100

  The user-defined column for text.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The column used to indicate the agency identifier.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "AiAgentName":{
            "maxLength":128,
            "type":"string",
            "description":"The AI agent team identifier.",
            "nullable":false
        },
        "ConfidenceScore":{
            "type":"number",
            "description":"The confidence score of the AI agent result.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":4
            }
        },
        "Content":{
            "type":"string",
            "description":"The result returned by the AI agent.",
            "format":"byte",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "QueryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name given for a query against the AI agent.",
            "nullable":false
        },
        "ResultId":{
            "type":"integer",
            "description":"The result identifier of an AI agent result, indicating primary key of the table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the query result against the AI agent.",
            "nullable":true,
            "default":"'Open'"
        },
        "TransId":{
            "maxLength":50,
            "type":"string",
            "description":"The application ID of the transaction record.",
            "nullable":true
        },
        "TransKey":{
            "type":"integer",
            "description":"The primary key of the transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of transaction in the AI agent result. For example, possible values are INSP, PMT, BL, PNZ, INC, CE, NOTICE, PAYMENT, and so on.",
            "nullable":false
        },
        "UserDefinedDate1":{
            "type":"string",
            "description":"The user-defined column for date.",
            "format":"date-time",
            "nullable":true
        },
        "UserDefinedNumber1":{
            "type":"number",
            "description":"The user-defined column for numbers.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "UserDefinedVarchar":{
            "maxLength":100,
            "type":"string",
            "description":"The user-defined column for text.",
            "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 : publicSectorAiAgentResults-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The column used to indicate the agency identifier.
• AiAgentName: string
  Maximum Length: 128

  The AI agent team identifier.
• ConfidenceScore: number
  The confidence score of the AI agent result.
• Content: string (byte)
  The result returned by the AI agent.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• QueryName: string
  Maximum Length: 50

  The name given for a query against the AI agent.
• ResultId: integer (int64)
  The result identifier of an AI agent result, indicating primary key of the table.
• Status: string
  Maximum Length: 15

  Default Value: 'Open'

  The status of the query result against the AI agent.
• TransactionType: string
  Maximum Length: 30

  The type of transaction in the AI agent result. For example, possible values are INSP, PMT, BL, PNZ, INC, CE, NOTICE, PAYMENT, and so on.
• TransId: string
  Maximum Length: 50

  The application ID of the transaction record.
• TransKey: integer (int64)
  The primary key of the transaction record.
• UserDefinedDate1: string (date-time)
  The user-defined column for date.
• UserDefinedNumber1: number
  The user-defined column for numbers.
• UserDefinedVarchar: string
  Maximum Length: 100

  The user-defined column for text.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The column used to indicate the agency identifier.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AiAgentName":{
            "maxLength":128,
            "type":"string",
            "description":"The AI agent team identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfidenceScore":{
            "type":"number",
            "description":"The confidence score of the AI agent result.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":4
            },
            "x-queryable":true
        },
        "Content":{
            "type":"string",
            "description":"The result returned by the AI agent.",
            "format":"byte",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "QueryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name given for a query against the AI agent.",
            "nullable":false,
            "x-queryable":true
        },
        "ResultId":{
            "type":"integer",
            "description":"The result identifier of an AI agent result, indicating primary key of the table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the query result against the AI agent.",
            "nullable":true,
            "default":"'Open'",
            "x-queryable":true
        },
        "TransId":{
            "maxLength":50,
            "type":"string",
            "description":"The application ID of the transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "TransKey":{
            "type":"integer",
            "description":"The primary key of the transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of transaction in the AI agent result. For example, possible values are INSP, PMT, BL, PNZ, INC, CE, NOTICE, PAYMENT, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "UserDefinedDate1":{
            "type":"string",
            "description":"The user-defined column for date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UserDefinedNumber1":{
            "type":"number",
            "description":"The user-defined column for numbers.",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "UserDefinedVarchar":{
            "maxLength":100,
            "type":"string",
            "description":"The user-defined column for text.",
            "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