Create a set of conditions against a record
post
/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists
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 : publicSectorConditionLists-item
Type:
Show Source
object
-
AdditionalInfo(optional):
string
Title:
Additional Information
Maximum Length:150
The additional details about the condition that was applied against a transaction. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
AppliedBy(optional):
string
Title:
Applied By
Maximum Length:64
The name of the user who applied the condition. -
AppliedDate(optional):
string(date-time)
Title:
Applied Date
The date when the condition was applied against a transaction. -
ApplyToInProcessTrans(optional):
boolean
Title:
Include in-process transactions
The option to enable the condition to be inherited to exiting transactions (in-process transactions).The valid values are Y and N. Select Y to apply the condition to all the existing transactions belonging to the same parcel. -
BrPreventInsResult(optional):
string
Title:
Prevent Inspection Result
Maximum Length:1
The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventInsSched(optional):
string
Title:
Prevent Inspection Schedule
Maximum Length:1
The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventIssue(optional):
string
Title:
Prevent Issue or Final
Maximum Length:1
The option to enable the Prevent Issue or Final workflow functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventNew(optional):
string
Title:
Prevent New
Maximum Length:1
The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventRenewal(optional):
string
Title:
Prevent Renewal
Maximum Length:1
The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventWorkflow(optional):
string
Title:
Prevent Workflow Advancing
Maximum Length:1
The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrRestrictPayment(optional):
string
Title:
Restrict Payment
Maximum Length:1
The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'. -
ConditionKey(optional):
integer(int64)
The unique identifier of the applied condition against a transaction.
-
ConditionName(optional):
string
Title:
Condition Name
Maximum Length:30
The name of the condition that is applied. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who applied the condition. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the condition was applied. -
Description(optional):
string
Title:
Description
Maximum Length:500
The detailed description about the condition applied against a transaction. -
InheritFlag(optional):
boolean
Title:
Apply Condition to Transactions
The option that indicates that the condition was inherited and not applied directly against the transaction. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the condition was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the condition. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectKeyGenValue1(optional):
string
Maximum Length:
50
The string key value 1 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue2(optional):
string
Maximum Length:
50
The string key value 2 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue3(optional):
string
Maximum Length:
50
The string key value 3 to identify the unique transaction to which a condition is applied. -
ObjectKeyNumValue1(optional):
integer(int64)
The integer key value 1 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue2(optional):
integer(int64)
The integer key value 2 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue3(optional):
integer(int64)
The integer key value 3 to identify the unique transaction to which a condition is applied.
-
ObjectSubType(optional):
string
Maximum Length:
3
The unique sub type value to identify the sub type of a record. For example, an address within a parcel. -
ObjectType(optional):
string
Title:
Object Type
Maximum Length:3
The unique type of record against which a condition is applied. -
ParentConditionKey(optional):
integer(int64)
The unique identifier of the condition from the parent transaction.
-
Priority(optional):
integer(int32)
Title:
Priority
The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low. -
PublicFlag(optional):
boolean
Title:
Display Description to Public
The option to enable the description to be visible for the public users. The default value is 'Y'. -
RemovalDate(optional):
string(date-time)
Title:
Resolved Date
The date when the condition was resolved. -
RemovedBy(optional):
string
Title:
Resolved By
Maximum Length:64
The name of the user who resolved the condition. -
ResolutionAction(optional):
string
Title:
Resolution Action
Maximum Length:150
The detailed information about the action that was taken to resolve the condition. -
ResolveInProcessTrans(optional):
boolean
Title:
Resolve condition applied to transactions
The option to include all the in-process transactions for the resolution. The valid values are Y and N. Select Y to include all the in-process transactions. -
Severity(optional):
integer(int32)
Title:
Severity
The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice. -
Status(optional):
string
Title:
Status
Maximum Length:1
The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.
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.
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 : publicSectorConditionLists-item
Type:
Show Source
object
-
AdditionalInfo(optional):
string
Title:
Additional Information
Maximum Length:150
The additional details about the condition that was applied against a transaction. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
AppliedBy(optional):
string
Title:
Applied By
Maximum Length:64
The name of the user who applied the condition. -
AppliedDate(optional):
string(date-time)
Title:
Applied Date
The date when the condition was applied against a transaction. -
ApplyToInProcessTrans(optional):
boolean
Title:
Include in-process transactions
The option to enable the condition to be inherited to exiting transactions (in-process transactions).The valid values are Y and N. Select Y to apply the condition to all the existing transactions belonging to the same parcel. -
BrPreventInsResult(optional):
string
Title:
Prevent Inspection Result
Maximum Length:1
The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventInsSched(optional):
string
Title:
Prevent Inspection Schedule
Maximum Length:1
The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventIssue(optional):
string
Title:
Prevent Issue or Final
Maximum Length:1
The option to enable the Prevent Issue or Final workflow functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventNew(optional):
string
Title:
Prevent New
Maximum Length:1
The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventRenewal(optional):
string
Title:
Prevent Renewal
Maximum Length:1
The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrPreventWorkflow(optional):
string
Title:
Prevent Workflow Advancing
Maximum Length:1
The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'. -
BrRestrictPayment(optional):
string
Title:
Restrict Payment
Maximum Length:1
The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'. -
ConditionKey(optional):
integer(int64)
The unique identifier of the applied condition against a transaction.
-
ConditionName(optional):
string
Title:
Condition Name
Maximum Length:30
The name of the condition that is applied. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who applied the condition. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the condition was applied. -
Description(optional):
string
Title:
Description
Maximum Length:500
The detailed description about the condition applied against a transaction. -
InheritFlag(optional):
boolean
Title:
Apply Condition to Transactions
The option that indicates that the condition was inherited and not applied directly against the transaction. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the condition was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the condition. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectKeyGenValue1(optional):
string
Maximum Length:
50
The string key value 1 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue2(optional):
string
Maximum Length:
50
The string key value 2 to identify the unique transaction to which a condition is applied. -
ObjectKeyGenValue3(optional):
string
Maximum Length:
50
The string key value 3 to identify the unique transaction to which a condition is applied. -
ObjectKeyNumValue1(optional):
integer(int64)
The integer key value 1 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue2(optional):
integer(int64)
The integer key value 2 to identify the unique transaction to which a condition is applied.
-
ObjectKeyNumValue3(optional):
integer(int64)
The integer key value 3 to identify the unique transaction to which a condition is applied.
-
ObjectSubType(optional):
string
Maximum Length:
3
The unique sub type value to identify the sub type of a record. For example, an address within a parcel. -
ObjectType(optional):
string
Title:
Object Type
Maximum Length:3
The unique type of record against which a condition is applied. -
ParentConditionKey(optional):
integer(int64)
The unique identifier of the condition from the parent transaction.
-
Priority(optional):
integer(int32)
Title:
Priority
The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low. -
PublicFlag(optional):
boolean
Title:
Display Description to Public
The option to enable the description to be visible for the public users. The default value is 'Y'. -
RemovalDate(optional):
string(date-time)
Title:
Resolved Date
The date when the condition was resolved. -
RemovedBy(optional):
string
Title:
Resolved By
Maximum Length:64
The name of the user who resolved the condition. -
ResolutionAction(optional):
string
Title:
Resolution Action
Maximum Length:150
The detailed information about the action that was taken to resolve the condition. -
ResolveInProcessTrans(optional):
boolean
Title:
Resolve condition applied to transactions
The option to include all the in-process transactions for the resolution. The valid values are Y and N. Select Y to include all the in-process transactions. -
Severity(optional):
integer(int32)
Title:
Severity
The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice. -
Status(optional):
string
Title:
Status
Maximum Length:1
The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.
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.