Update a condition
patch
/fscmRestApi/resources/11.13.18.05/publicSectorConditions/{publicSectorConditionsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorConditionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and ConditionName ---for the Conditions resource and used to uniquely identify an instance of Conditions. The client should not generate the hash key value. Instead, the client should query on the Conditions collection resource with a filter on the primary key values in order to navigate to a specific instance of Conditions.
For example: publicSectorConditions?q=AgencyId=<value1>;ConditionName=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorConditions-item
Type:
Show Source
object-
AdditionalInfo(optional):
string
Title:
Additional InformationMaximum Length:500The additional Information about the condition and resolution actions. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
BrPreventFinalIns(optional):
string
Title:
Prevent Final InspectionMaximum Length:1Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N. -
BrPreventInsResult(optional):
string
Title:
Prevent Inspection ResultMaximum Length:1Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N. -
BrPreventInsSched(optional):
string
Title:
Prevent Inspection ScheduleMaximum Length:1Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N. -
BrPreventIssue(optional):
string
Title:
Prevent Issue or FinalMaximum Length:1Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N. -
BrPreventNew(optional):
string
Title:
Prevent Application ProgressMaximum Length:1Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N. -
BrPreventWorkflow(optional):
string
Title:
Prevent Workflow AdvancementMaximum Length:1Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N. -
BrRestrictPayment(optional):
string
Title:
Prevent PaymentMaximum Length:1Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N. -
ConditionName(optional):
string
Title:
Condition NameMaximum Length:50The unique name of the condition. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the condition. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the condition was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:500The detailed description of the condition. -
DisplayMessage(optional):
string
Title:
Display MessageMaximum Length:300The information about the condition that is visible across all the transactions. -
EnabledFlag(optional):
string
Title:
EnabledMaximum Length:1Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available. -
InheritFlag(optional):
string
Title:
Apply Condition to TransactionsMaximum Length:1Indicates if the condition is inheritable. The default value is N. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the condition was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the condition. -
links(optional):
array Items
Title:
ItemsLink Relations -
ObjectType(optional):
string
Title:
Object TypeMaximum Length:3The type of record against which a condition can be applied. -
Priority(optional):
integer(int32)
Title:
PriorityThe priority of the condition as set by the agency. -
Severity(optional):
integer(int32)
Title:
SeverityThe severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe 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 : publicSectorConditions-item
Type:
Show Source
object-
AdditionalInfo(optional):
string
Title:
Additional InformationMaximum Length:500The additional Information about the condition and resolution actions. -
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
BrPreventFinalIns(optional):
string
Title:
Prevent Final InspectionMaximum Length:1Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N. -
BrPreventInsResult(optional):
string
Title:
Prevent Inspection ResultMaximum Length:1Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N. -
BrPreventInsSched(optional):
string
Title:
Prevent Inspection ScheduleMaximum Length:1Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N. -
BrPreventIssue(optional):
string
Title:
Prevent Issue or FinalMaximum Length:1Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N. -
BrPreventNew(optional):
string
Title:
Prevent Application ProgressMaximum Length:1Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N. -
BrPreventWorkflow(optional):
string
Title:
Prevent Workflow AdvancementMaximum Length:1Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N. -
BrRestrictPayment(optional):
string
Title:
Prevent PaymentMaximum Length:1Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N. -
ConditionName(optional):
string
Title:
Condition NameMaximum Length:50The unique name of the condition. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the condition. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the condition was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:500The detailed description of the condition. -
DisplayMessage(optional):
string
Title:
Display MessageMaximum Length:300The information about the condition that is visible across all the transactions. -
EnabledFlag(optional):
string
Title:
EnabledMaximum Length:1Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available. -
InheritFlag(optional):
string
Title:
Apply Condition to TransactionsMaximum Length:1Indicates if the condition is inheritable. The default value is N. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the condition was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the condition. -
links(optional):
array Items
Title:
ItemsLink Relations -
ObjectType(optional):
string
Title:
Object TypeMaximum Length:3The type of record against which a condition can be applied. -
Priority(optional):
integer(int32)
Title:
PriorityThe priority of the condition as set by the agency. -
Severity(optional):
integer(int32)
Title:
SeverityThe severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.