Get a set of contextual help details
get
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps/{publicSectorContextHelpsUniqID}/child/ContextHelpDetail/{ContextHelpDetailUniqID}
Request
Path Parameters
-
ContextHelpDetailUniqID: integer
This is the hash key of the attributes which make up the composite key--- AppTypeCode, ContxthlpPage, ContxthlpPageobj and ContxthlpDataType ---for the Contextual Help Details resource and used to uniquely identify an instance of Contextual Help Details. The client should not generate the hash key value. Instead, the client should query on the Contextual Help Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Contextual Help Details.
For example: ContextHelpDetail?q=AppTypeCode=<value1>;ContxthlpPage=<value2>;ContxthlpPageobj=<value3>;ContxthlpDataType=<value4> -
publicSectorContextHelpsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AppTypeCode, ContxthlpPage and ContxthlpPageobj ---for the Contextual Help resource and used to uniquely identify an instance of Contextual Help. The client should not generate the hash key value. Instead, the client should query on the Contextual Help collection resource with a filter on the primary key values in order to navigate to a specific instance of Contextual Help.
For example: publicSectorContextHelps?q=AppTypeCode=<value1>;ContxthlpPage=<value2>;ContxthlpPageobj=<value3>
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 : publicSectorContextHelps-ContextHelpDetail-item
Type:
Show Source
object
-
AppTypeCode(optional):
string
Title:
Type Code
Maximum Length:100
The application type code of the contextual help details. -
ContxthlpClob(optional):
string
Title:
Help Content
The content that is displayed as contextual help. -
ContxthlpDataType(optional):
string
Title:
Type
Maximum Length:3
The data type for which the contextual help details was defined. -
ContxthlpPage(optional):
string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help details. -
ContxthlpPageobj(optional):
string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help details. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the contextual help detail was created. -
DeletedFlag(optional):
boolean
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
-
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the contextual help details are available to be used. The default value is false. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the contextual help details were last modified. -
links(optional):
array Items
Title:
Items
Link Relations -
NlsContext(optional):
string
Maximum Length:
4000
The National Language Support (NLS) context of the contextual help details. -
NlsType(optional):
string
Maximum Length:
30
The National Language Support (NLS) type of the contextual help details. -
SeedDataLock(optional):
integer(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
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.