Create a new contextual help entry
post
/fscmRestApi/resources/11.13.18.05/publicSectorContextHelps
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AppTypeCode(required): string
Title:
Type Code
Maximum Length:100
The application type code of contextual help entry. -
ContextHelpDetail: array
Contextual Help Details
Title:
Contextual Help Details
The contextual help details resource is used to create or modify the desired help text. -
ContxthlpPage(required): string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help entry. -
ContxthlpPageobj(required): string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help entry. -
DeletedFlag(required): boolean
Maximum Length:
1
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: string
Title:
Description
Maximum Length:100
The description of the contextual help entry. -
SeedDataLock(required): 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 details resource is used to create or modify the desired help text.
Show Source
Nested Schema : publicSectorContextHelps-ContextHelpDetail-item-post-request
Type:
Show Source
object
-
AppTypeCode: string
Title:
Type Code
Maximum Length:100
The application type code of the contextual help details. -
ContxthlpClob: string
(byte)
Title:
Help Content
The content that is displayed as contextual help. -
ContxthlpDataType: string
Title:
Type
Maximum Length:3
The data type for which the contextual help details was defined. -
ContxthlpPage: string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help details. -
ContxthlpPageobj: string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help details. -
DeletedFlag: boolean
Maximum Length:
1
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: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the contextual help details are available to be used. The default value is false. -
NlsContext: string
Maximum Length:
4000
The National Language Support (NLS) context of the contextual help details. -
NlsType: string
Maximum Length:
30
The National Language Support (NLS) type of the contextual help details. -
SeedDataLock: 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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorContextHelps-item-response
Type:
Show Source
object
-
AppTypeCode: string
Title:
Type Code
Maximum Length:100
The application type code of contextual help entry. -
ContextHelpDetail: array
Contextual Help Details
Title:
Contextual Help Details
The contextual help details resource is used to create or modify the desired help text. -
ContxthlpPage: string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help entry. -
ContxthlpPageobj: string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help entry. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the contextual help entry was created. -
DeletedFlag: boolean
Maximum Length:
1
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: string
Title:
Description
Maximum Length:100
The description of the contextual help entry. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the contextual help entry were last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: 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 details resource is used to create or modify the desired help text.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorContextHelps-ContextHelpDetail-item-response
Type:
Show Source
object
-
AppTypeCode: string
Title:
Type Code
Maximum Length:100
The application type code of the contextual help details. -
ContxthlpClob: string
(byte)
Title:
Help Content
The content that is displayed as contextual help. -
ContxthlpDataType: string
Title:
Type
Maximum Length:3
The data type for which the contextual help details was defined. -
ContxthlpPage: string
Title:
Page Name
Maximum Length:30
The name of the page associated with the contextual help details. -
ContxthlpPageobj: string
Title:
Page Object
Maximum Length:30
The name of the object associated with the contextual help details. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the contextual help detail was created. -
DeletedFlag: boolean
Maximum Length:
1
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: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the contextual help details are available to be used. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the contextual help details were last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NlsContext: string
Maximum Length:
4000
The National Language Support (NLS) context of the contextual help details. -
NlsType: string
Maximum Length:
30
The National Language Support (NLS) type of the contextual help details. -
SeedDataLock: 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ContextHelpDetail
-
Parameters:
- publicSectorContextHelpsUniqID:
$request.path.publicSectorContextHelpsUniqID
The contextual help details resource is used to create or modify the desired help text. - publicSectorContextHelpsUniqID: