Create a new contextual help entry
post
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
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 : publicSectorContextHelps-item
Type:
Show Source
object
-
AppTypeCode(optional):
string
Title:
Type Code
Maximum Length:100
The application type code of contextual help entry. -
ContextHelpDetail(optional):
array Contextual Help Details
Title:
Contextual Help Details
The contextual help resource is used to view, create, or modify contextual help defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page. -
ContxthlpPage(optional):
string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help entry. -
ContxthlpPageobj(optional):
string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help entry. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the contextual help entry. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the contextual help entry 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.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the contextual help entry. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the contextual help entry were last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the contextual help entry. -
links(optional):
array Items
Title:
Items
Link Relations -
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 : Contextual Help Details
Type:
array
Title:
Contextual Help Details
The contextual help resource is used to view, create, or modify contextual help defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page.
Show Source
Nested 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. -
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 : publicSectorContextHelps-item
Type:
Show Source
object
-
AppTypeCode(optional):
string
Title:
Type Code
Maximum Length:100
The application type code of contextual help entry. -
ContextHelpDetail(optional):
array Contextual Help Details
Title:
Contextual Help Details
The contextual help resource is used to view, create, or modify contextual help defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page. -
ContxthlpPage(optional):
string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help entry. -
ContxthlpPageobj(optional):
string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help entry. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the contextual help entry. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the contextual help entry 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.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the contextual help entry. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the contextual help entry were last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the contextual help entry. -
links(optional):
array Items
Title:
Items
Link Relations -
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 : Contextual Help Details
Type:
array
Title:
Contextual Help Details
The contextual help resource is used to view, create, or modify contextual help defined for fields or areas on a page. Contextual help can be defined for static pages as well as for user defined paged created using the Permit Designer by an agency. The contextual help resource defines the association to a particular field or area on a page.
Show Source
Nested 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. -
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.