Jump to

• Request
• Response

Update a stock profile

patch

/hcmRestApi/resources/11.13.18.05/compensationStockProfiles/{compensationStockProfilesUniqID}

Request

Path Parameters

• compensationStockProfilesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- StartDate and StockDefaultingCode ---for the Stock Profiles resource and used to uniquely identify an instance of Stock Profiles. The client should not generate the hash key value. Instead, the client should query on the Stock Profiles collection resource with a filter on the primary key values in order to navigate to a specific instance of Stock Profiles.
  
  For example: compensationStockProfiles?q=StartDate=<value1>;StockDefaultingCode=<value2>

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

• ClassType: string
  Maximum Length: 30

  Class type such as common or preferred stock shares.
• EndDate: string (date)
  End date of the stock profile.
• ExpirationDate: string (date)
  Expiration date of stock shares.
• GrantId: string
  Maximum Length: 30

  Unique identifier of the stock grant.
• GrantName: string
  Maximum Length: 100

  Name of the stock grant.
• GrantNumber: string
  Maximum Length: 30

  Number of the stock grant.
• GrantPrice: number
  Price at the time the shares were originally granted.
• GrantReasonCode: string
  Maximum Length: 30

  Reason code for the stock grant.
• GrantType: string
  Maximum Length: 30

  Code of the grant type.
• OtherWorkerInformation: string
  Maximum Length: 64

  Other information.
• StartDate: string (date)
  Start date of the stock profile.
• StatusCode: string
  Maximum Length: 30

  Status code of the stock profile.
• StockDefaultingCode: string
  Maximum Length: 30

  Code of the stock profile.
• TradingSymbol: string
  Maximum Length: 30

  Trading symbol of the stock.

{
    "type":"object",
    "properties":{
        "ClassType":{
            "maxLength":30,
            "type":"string",
            "description":"Class type such as common or preferred stock shares.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the stock profile.",
            "format":"date",
            "nullable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of stock shares.",
            "format":"date",
            "nullable":true
        },
        "GrantId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the stock grant.",
            "nullable":true
        },
        "GrantName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the stock grant.",
            "nullable":true
        },
        "GrantNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the stock grant.",
            "nullable":true
        },
        "GrantPrice":{
            "type":"number",
            "description":"Price at the time the shares were originally granted.",
            "nullable":true
        },
        "GrantReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for the stock grant.",
            "nullable":true
        },
        "GrantType":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the grant type.",
            "nullable":true
        },
        "OtherWorkerInformation":{
            "maxLength":64,
            "type":"string",
            "description":"Other information.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the stock profile.",
            "format":"date",
            "nullable":false
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the stock profile.",
            "nullable":false
        },
        "StockDefaultingCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the stock profile.",
            "nullable":false
        },
        "TradingSymbol":{
            "maxLength":30,
            "type":"string",
            "description":"Trading symbol of the stock.",
            "nullable":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 : compensationStockProfiles-item-response

Type: object

Show Source

• ClassType: string
  Maximum Length: 30

  Class type such as common or preferred stock shares.
• EndDate: string (date)
  End date of the stock profile.
• ExpirationDate: string (date)
  Expiration date of stock shares.
• GrantId: string
  Maximum Length: 30

  Unique identifier of the stock grant.
• GrantName: string
  Maximum Length: 100

  Name of the stock grant.
• GrantNumber: string
  Maximum Length: 30

  Number of the stock grant.
• GrantPrice: number
  Price at the time the shares were originally granted.
• GrantReasonCode: string
  Maximum Length: 30

  Reason code for the stock grant.
• GrantType: string
  Maximum Length: 30

  Code of the grant type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OtherWorkerInformation: string
  Maximum Length: 64

  Other information.
• StartDate: string (date)
  Start date of the stock profile.
• StatusCode: string
  Maximum Length: 30

  Status code of the stock profile.
• StockDefaultingCode: string
  Maximum Length: 30

  Code of the stock profile.
• TradingSymbol: string
  Maximum Length: 30

  Trading symbol of the stock.

{
    "type":"object",
    "properties":{
        "ClassType":{
            "maxLength":30,
            "type":"string",
            "description":"Class type such as common or preferred stock shares.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the stock profile.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of stock shares.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GrantId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the stock grant.",
            "nullable":true,
            "x-queryable":true
        },
        "GrantName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the stock grant.",
            "nullable":true,
            "x-queryable":true
        },
        "GrantNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the stock grant.",
            "nullable":true,
            "x-queryable":true
        },
        "GrantPrice":{
            "type":"number",
            "description":"Price at the time the shares were originally granted.",
            "nullable":true,
            "x-queryable":true
        },
        "GrantReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason code for the stock grant.",
            "nullable":true,
            "x-queryable":true
        },
        "GrantType":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the grant type.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherWorkerInformation":{
            "maxLength":64,
            "type":"string",
            "description":"Other information.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the stock profile.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Status code of the stock profile.",
            "nullable":false,
            "x-queryable":true
        },
        "StockDefaultingCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the stock profile.",
            "nullable":false,
            "x-queryable":true
        },
        "TradingSymbol":{
            "maxLength":30,
            "type":"string",
            "description":"Trading symbol of the stock.",
            "nullable":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