Jump to

• Request
• Response

Update a grants personnel keyword

patch

/fscmRestApi/resources/11.13.18.05/grantsPersonnel/{PersonId}/child/GrantsPersonnelKeyword/{PersonnelKeywordId}

Request

Path Parameters

• PersonId(required): integer(int64)
  Identifier of the person selected from Human Resources to administer and manage awards.
• PersonnelKeywordId(required): integer(int64)
  Identifier of the keyword associated with the Grants personnel.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• KeywordId: number
  Title: Keyword

  Identifier of the keyword selected from Grants keywords.
• KeywordName: string
  Title: Keyword Name

  Maximum Length: 80

  Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel.
• PersonId: number
  Title: Person Name

  Identifier of the person selected from Human Resources to administer and manage awards.
• PersonnelKeywordId: integer (int64)
  Identifier of the keyword associated with the Grants personnel.

{
    "type":"object",
    "properties":{
        "KeywordId":{
            "title":"Keyword",
            "type":"number",
            "description":"Identifier of the keyword selected from Grants keywords.",
            "nullable":false
        },
        "KeywordName":{
            "title":"Keyword Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PersonId":{
            "title":"Person Name",
            "type":"number",
            "description":"Identifier of the person selected from Human Resources to administer and manage awards.",
            "nullable":false
        },
        "PersonnelKeywordId":{
            "type":"integer",
            "description":"Identifier of the keyword associated with the Grants personnel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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 : grantsPersonnel-GrantsPersonnelKeyword-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Details of the keyword that is used to track the key subject area for the Grants personnel.
• FromDate: string (date)
  Title: From Date

  Read Only: true

  Date when the keyword becomes active.
• KeywordId: number
  Title: Keyword

  Identifier of the keyword selected from Grants keywords.
• KeywordName: string
  Title: Keyword Name

  Maximum Length: 80

  Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: number
  Title: Person Name

  Identifier of the person selected from Human Resources to administer and manage awards.
• PersonnelKeywordId: integer (int64)
  Identifier of the keyword associated with the Grants personnel.
• ToDate: string (date)
  Title: To Date

  Read Only: true

  Date after which the keyword is inactive.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Details of the keyword that is used to track the key subject area for the Grants personnel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date when the keyword becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KeywordId":{
            "title":"Keyword",
            "type":"number",
            "description":"Identifier of the keyword selected from Grants keywords.",
            "nullable":false,
            "x-queryable":true
        },
        "KeywordName":{
            "title":"Keyword Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the keyword that is used to uniquely describe and track the key subject area for the Grants personnel.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person Name",
            "type":"number",
            "description":"Identifier of the person selected from Human Resources to administer and manage awards.",
            "nullable":false,
            "x-queryable":true
        },
        "PersonnelKeywordId":{
            "type":"integer",
            "description":"Identifier of the keyword associated with the Grants personnel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date after which the keyword is inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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