Help Topic Abstract
A service to operate on the abstract of a help document, with specific attributes for industry, localization, release, and language.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/atk/helpPortal/helpPortalService/}AtkHelpPortalService
Service WSDL URL: https://servername/fscmService/AtkHelpPortalService?WSDL
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
Operations
findHelpTopicAbstract
Finds help abstract by the help window identifier (UAPKey) and additional optional criteria.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
criteria |
Help Topic Criteria |
Criteria for help file abstract queries. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Abstract of the help file, with specific attributes for industry, localization, release, and language. |
findHelpTopicContentOnLocalCall
Returns the Help Content blob required for FSM or any product team UAP uptake.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
pTopicId |
string |
The topicId to be passed. |
|
urlContextRoot |
string |
URL context root of the Web App. |
|
uapKey |
string |
UAP key of the Product team consuming the WebApp. |
|
language |
string |
Language being passed. |
|
territory |
string |
Territory code being passed. |
|
release |
string |
Release value being passed. |
|
industry |
string |
Industry code,could be null. |
|
taskFlowId |
string |
Product team Task-flow Id being passed. |
|
workAreaId |
string |
Workarea id being passed,could be null. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns the Help Topic blob content for the given topic-id and UAP key passed. |
getDfltObjAttrHints
An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
An operation that returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
An operation to get the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |