Jump to

• Request
• Response

Update a help setup

patch

/fscmRestApi/resources/11.13.18.05/publicSectorHelpSetups/{AgencyId}

Request

Supported Media Types

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

Path Parameters

• AgencyId: integer
  The unique identifier of the agency associated with the help setup.

Body ()

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

Root Schema : publicSectorHelpSetups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the help setup.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the help setup.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the the help setup was created.
• HelpDomainId(optional): string
  Title: Domain ID

  Maximum Length: 254

  The unique identifier of the domain associated with the help setup.
• HelpLibContext(optional): string
  Title: Library Context

  Maximum Length: 254

  The context name and location on the Oracle Help Center for the help entries.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the help setup was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who has last updated the help setup.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the help setup."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the help setup.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the the help setup was created.",
            "title":"Creation Date"
        },
        "HelpDomainId":{
            "maxLength":254,
            "type":"string",
            "description":"The unique identifier of the domain associated with the help setup.",
            "title":"Domain ID"
        },
        "HelpLibContext":{
            "maxLength":254,
            "type":"string",
            "description":"The context name and location on the Oracle Help Center for the help entries.",
            "title":"Library Context"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the help setup was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the help setup.",
            "title":"Last Updated By"
        },
        "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 : publicSectorHelpSetups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the help setup.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the help setup.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date the the help setup was created.
• HelpDomainId(optional): string
  Title: Domain ID

  Maximum Length: 254

  The unique identifier of the domain associated with the help setup.
• HelpLibContext(optional): string
  Title: Library Context

  Maximum Length: 254

  The context name and location on the Oracle Help Center for the help entries.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the help setup was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who has last updated the help setup.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the help setup."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the help setup.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the the help setup was created.",
            "title":"Creation Date"
        },
        "HelpDomainId":{
            "maxLength":254,
            "type":"string",
            "description":"The unique identifier of the domain associated with the help setup.",
            "title":"Domain ID"
        },
        "HelpLibContext":{
            "maxLength":254,
            "type":"string",
            "description":"The context name and location on the Oracle Help Center for the help entries.",
            "title":"Library Context"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the help setup was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who has last updated the help setup.",
            "title":"Last Updated By"
        },
        "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