Create a set of contextual help details
post
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails
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 : publicSectorContextHelpDetails-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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created 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. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the contextual help details. -
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.
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 : publicSectorContextHelpDetails-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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created 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. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the contextual help details. -
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.