Get a condition
get
/fscmRestApi/resources/11.13.18.05/publicSectorPromptConditions/{publicSectorPromptConditionsUniqID}
Request
Path Parameters
-
publicSectorPromptConditionsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and ConditionName ---for the Prompt Conditions resource and used to uniquely identify an instance of Prompt Conditions. The client should not generate the hash key value. Instead, the client should query on the Prompt Conditions collection resource with a filter on the primary key values in order to navigate to a specific instance of Prompt Conditions.
For example: publicSectorPromptConditions?q=AgencyId=<value1>;ConditionName=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorPromptConditions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the public sector agency.
-
ConditionName(optional):
string
Title:
Condition Name
Maximum Length:30
The unique name for the condition. -
Description(optional):
string
Title:
Description
Maximum Length:500
The detailed description about why the condition is applied. -
DisplayMessage(optional):
string
Title:
Display Message
Maximum Length:150
The brief information about the condition that is visible across all the transactions. -
InheritFlag(optional):
boolean
Title:
Apply Condition to Transactions
Indicates if the condition is inheritable. The default value is 'N'. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectType(optional):
string
Title:
Object Type
Maximum Length:3
The type of record against which a condition can be applied. -
Severity(optional):
integer(int32)
Title:
Severity
The 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 reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.