Jump to

• Request
• Response

Update a recommended list

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders/{OpaResultId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• OpaResultId: integer
  The key identifier of the acknowledgment number .

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorOpaResultHeaders-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier associated with these results.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EmailId(optional): string
  Maximum Length: 256

  The email address of the user who submitted the OPA questionnaire.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OpaResultId(optional): integer(int64)
  The key identifier of the acknowledgment number .
• OpaResultList(optional): array Recommended Permits
  Title: Recommended Permits

  The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.
• ResultLink(optional): string
  An autogenerated link used to view the saved recommendation results for anonymous users.
• ResultTitle(optional): string
  Maximum Length: 250

  The title of the OPA results entered by the user.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier associated with these results.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EmailId":{
            "maxLength":256,
            "type":"string",
            "description":"The email address of the user who submitted the OPA questionnaire."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OpaResultId":{
            "format":"int64",
            "type":"integer",
            "description":"The key identifier of the acknowledgment number ."
        },
        "OpaResultList":{
            "items":{
                "$ref":"#/definitions/publicSectorOpaResultHeaders-OpaResultList-item"
            },
            "type":"array",
            "description":"The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.",
            "title":"Recommended Permits"
        },
        "ResultLink":{
            "type":"string",
            "description":"An autogenerated link used to view the saved recommendation results for anonymous users."
        },
        "ResultTitle":{
            "maxLength":250,
            "type":"string",
            "description":"The title of the OPA results entered by the user."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Recommended Permits

Type: array

Title: Recommended Permits

The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.

Show Source

• Array of: object publicSectorOpaResultHeaders-OpaResultList-item

{
    "items":{
        "$ref":"#/definitions/publicSectorOpaResultHeaders-OpaResultList-item"
    },
    "type":"array",
    "description":"The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.",
    "title":"Recommended Permits"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorOpaResultHeaders-OpaResultList-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier associated with these results.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Maximum Length: 1000

  The description of the permit type associated with an OPA result.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OpaResultId(optional): integer(int64)
  The key identifier of the acknowledgment number .
• OpaResultListId(optional): integer(int64)
  The unique key that identifies the OPA result item.
• RecordType(optional): string
  Maximum Length: 100

  The record type or permit type associated with an OPA result.
• RecordTypeId(optional): string
  Maximum Length: 30

  The identifier of the record type associated with an OPA result.
• Url(optional): string
  The URL for a page that provides more details about the permit type associated with an OPA result.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier associated with these results.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the permit type associated with an OPA result."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OpaResultId":{
            "format":"int64",
            "type":"integer",
            "description":"The key identifier of the acknowledgment number ."
        },
        "OpaResultListId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique key that identifies the OPA result item."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type or permit type associated with an OPA result."
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the record type associated with an OPA result."
        },
        "Url":{
            "type":"string",
            "description":"The URL for a page that provides more details about the permit type associated with an OPA result."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaResultHeaders-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier associated with these results.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EmailId(optional): string
  Maximum Length: 256

  The email address of the user who submitted the OPA questionnaire.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OpaResultId(optional): integer(int64)
  The key identifier of the acknowledgment number .
• OpaResultList(optional): array Recommended Permits
  Title: Recommended Permits

  The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.
• ResultLink(optional): string
  An autogenerated link used to view the saved recommendation results for anonymous users.
• ResultTitle(optional): string
  Maximum Length: 250

  The title of the OPA results entered by the user.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier associated with these results.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EmailId":{
            "maxLength":256,
            "type":"string",
            "description":"The email address of the user who submitted the OPA questionnaire."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OpaResultId":{
            "format":"int64",
            "type":"integer",
            "description":"The key identifier of the acknowledgment number ."
        },
        "OpaResultList":{
            "items":{
                "$ref":"#/definitions/publicSectorOpaResultHeaders-OpaResultList-item"
            },
            "type":"array",
            "description":"The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.",
            "title":"Recommended Permits"
        },
        "ResultLink":{
            "type":"string",
            "description":"An autogenerated link used to view the saved recommendation results for anonymous users."
        },
        "ResultTitle":{
            "maxLength":250,
            "type":"string",
            "description":"The title of the OPA results entered by the user."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Recommended Permits

Type: array

Title: Recommended Permits

The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.

Show Source

• Array of: object publicSectorOpaResultHeaders-OpaResultList-item

{
    "items":{
        "$ref":"#/definitions/publicSectorOpaResultHeaders-OpaResultList-item"
    },
    "type":"array",
    "description":"The recommended permit results resource is used to view the recommended permits that were saved by registered public users. Users can review the saved recommended permits before applying for a permit.",
    "title":"Recommended Permits"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorOpaResultHeaders-OpaResultList-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier associated with these results.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Maximum Length: 1000

  The description of the permit type associated with an OPA result.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• OpaResultId(optional): integer(int64)
  The key identifier of the acknowledgment number .
• OpaResultListId(optional): integer(int64)
  The unique key that identifies the OPA result item.
• RecordType(optional): string
  Maximum Length: 100

  The record type or permit type associated with an OPA result.
• RecordTypeId(optional): string
  Maximum Length: 30

  The identifier of the record type associated with an OPA result.
• Url(optional): string
  The URL for a page that provides more details about the permit type associated with an OPA result.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier associated with these results.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the permit type associated with an OPA result."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "OpaResultId":{
            "format":"int64",
            "type":"integer",
            "description":"The key identifier of the acknowledgment number ."
        },
        "OpaResultListId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique key that identifies the OPA result item."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type or permit type associated with an OPA result."
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier of the record type associated with an OPA result."
        },
        "Url":{
            "type":"string",
            "description":"The URL for a page that provides more details about the permit type associated with an OPA result."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top