Jump to

• Request
• Response

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

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorContextHelps-item

Type: object

Show Source

• 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 details resource is used to create or modify the desired help text.
• 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.
• 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.
• 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.

{
    "properties":{
        "AppTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The application type code of contextual help entry.",
            "title":"Type Code"
        },
        "ContextHelpDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorContextHelps-ContextHelpDetail-item"
            },
            "type":"array",
            "description":"The contextual help details resource is used to create or modify the desired help text.",
            "title":"Contextual Help Details"
        },
        "ContxthlpPage":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the page associated with the contextual help entry.",
            "title":"Page Name"
        },
        "ContxthlpPageobj":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the object associated with the contextual help entry.",
            "title":"Page Object"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help entry was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the contextual help entry.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help entry were last modified.",
            "title":"Last Updated Date"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorContextHelps-ContextHelpDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContextHelps-ContextHelpDetail-item"
    },
    "type":"array",
    "description":"The contextual help details resource is used to create or modify the desired help text.",
    "title":"Contextual Help Details"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContextHelps-ContextHelpDetail-item

Type: object

Show Source

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

{
    "properties":{
        "AppTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The application type code of the contextual help details.",
            "title":"Type Code"
        },
        "ContxthlpClob":{
            "type":"string",
            "description":"The content that is displayed as contextual help.",
            "title":"Help Content"
        },
        "ContxthlpDataType":{
            "maxLength":3,
            "type":"string",
            "description":"The data type for which the contextual help details was defined.",
            "title":"Type"
        },
        "ContxthlpPage":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the page associated with the contextual help details.",
            "title":"Page Name"
        },
        "ContxthlpPageobj":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the object associated with the contextual help details.",
            "title":"Page Object"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help detail was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the contextual help details are available to be used. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help details were last modified.",
            "title":"Last Updated Date"
        },
        "NlsContext":{
            "maxLength":4000,
            "type":"string",
            "description":"The National Language Support (NLS) context of the contextual help details."
        },
        "NlsType":{
            "maxLength":30,
            "type":"string",
            "description":"The National Language Support (NLS) type of the contextual help details."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorContextHelps-item

Type: object

Show Source

• 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 details resource is used to create or modify the desired help text.
• 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.
• 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.
• 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.

{
    "properties":{
        "AppTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The application type code of contextual help entry.",
            "title":"Type Code"
        },
        "ContextHelpDetail":{
            "items":{
                "$ref":"#/definitions/publicSectorContextHelps-ContextHelpDetail-item"
            },
            "type":"array",
            "description":"The contextual help details resource is used to create or modify the desired help text.",
            "title":"Contextual Help Details"
        },
        "ContxthlpPage":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the page associated with the contextual help entry.",
            "title":"Page Name"
        },
        "ContxthlpPageobj":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the object associated with the contextual help entry.",
            "title":"Page Object"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help entry was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the contextual help entry.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help entry were last modified.",
            "title":"Last Updated Date"
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorContextHelps-ContextHelpDetail-item

{
    "items":{
        "$ref":"#/definitions/publicSectorContextHelps-ContextHelpDetail-item"
    },
    "type":"array",
    "description":"The contextual help details resource is used to create or modify the desired help text.",
    "title":"Contextual Help Details"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorContextHelps-ContextHelpDetail-item

Type: object

Show Source

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

{
    "properties":{
        "AppTypeCode":{
            "maxLength":100,
            "type":"string",
            "description":"The application type code of the contextual help details.",
            "title":"Type Code"
        },
        "ContxthlpClob":{
            "type":"string",
            "description":"The content that is displayed as contextual help.",
            "title":"Help Content"
        },
        "ContxthlpDataType":{
            "maxLength":3,
            "type":"string",
            "description":"The data type for which the contextual help details was defined.",
            "title":"Type"
        },
        "ContxthlpPage":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the page associated with the contextual help details.",
            "title":"Page Name"
        },
        "ContxthlpPageobj":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the object associated with the contextual help details.",
            "title":"Page Object"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help detail was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "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."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the contextual help details are available to be used. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the contextual help details were last modified.",
            "title":"Last Updated Date"
        },
        "NlsContext":{
            "maxLength":4000,
            "type":"string",
            "description":"The National Language Support (NLS) context of the contextual help details."
        },
        "NlsType":{
            "maxLength":30,
            "type":"string",
            "description":"The National Language Support (NLS) type of the contextual help details."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top