Create a set of recommendation lists
post
/fscmRestApi/resources/11.13.18.05/publicSectorOpaResultHeaders
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorOpaResultHeaders-item
Type:
Show Source
object
-
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.
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : publicSectorOpaResultHeaders-OpaResultList-item
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorOpaResultHeaders-item
Type:
Show Source
object
-
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.
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : publicSectorOpaResultHeaders-OpaResultList-item
Type:
Show Source
object
-
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.