Jump to

• Request
• Response

Create a set of contextual help details

post

/fscmRestApi/resources/11.13.18.05/publicSectorContextHelpDetails

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ContxthlpPage":{
            "title":"Page Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the page associated with the contextual help details.",
            "nullable":false
        },
        "NlsType":{
            "maxLength":"30",
            "type":"string",
            "description":"The National Language Support (NLS) type of the contextual help details.",
            "nullable":false
        },
        "ContxthlpPageobj":{
            "title":"Page Object",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the object associated with the contextual help details.",
            "nullable":false
        },
        "ContxthlpDataType":{
            "title":"Type",
            "maxLength":"3",
            "type":"string",
            "description":"The data type for which the contextual help details was defined.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the contextual help details are available to be used. The default value is false.",
            "nullable":true
        },
        "NlsContext":{
            "maxLength":"4000",
            "type":"string",
            "description":"The National Language Support (NLS) context of the contextual help details.",
            "nullable":true
        },
        "ContxthlpClob":{
            "title":"Help Content",
            "type":"string",
            "description":"The content that is displayed as contextual help.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AppTypeCode":{
            "title":"Type Code",
            "maxLength":"100",
            "type":"string",
            "description":"The application type code of the contextual help details.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorContextHelpDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the contextual help detail was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NlsType":{
            "maxLength":"30",
            "type":"string",
            "description":"The National Language Support (NLS) type of the contextual help details.",
            "nullable":false,
            "x-queryable":true
        },
        "ContxthlpPageobj":{
            "title":"Page Object",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the object associated with the contextual help details.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "NlsContext":{
            "maxLength":"4000",
            "type":"string",
            "description":"The National Language Support (NLS) context of the contextual help details.",
            "nullable":true,
            "x-queryable":true
        },
        "ContxthlpClob":{
            "title":"Help Content",
            "type":"string",
            "description":"The content that is displayed as contextual help.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AppTypeCode":{
            "title":"Type Code",
            "maxLength":"100",
            "type":"string",
            "description":"The application type code of the contextual help details.",
            "nullable":false,
            "x-queryable":true
        },
        "ContxthlpPage":{
            "title":"Page Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the page associated with the contextual help details.",
            "nullable":false,
            "x-queryable":true
        },
        "ContxthlpDataType":{
            "title":"Type",
            "maxLength":"3",
            "type":"string",
            "description":"The data type for which the contextual help details was defined.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the contextual help details are available to be used. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time that the contextual help details were last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top