Jump to

• Request
• Response

Create an excluded worker for the goal plan

post

/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers

Request

Path Parameters

• GoalPlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.
• Upsert-Mode: string
  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

• AssignmentId: integer (int64)
  Unique identifier for the assignment of the worker excluded from the goal plan.
• MassRequestExemptionId: integer (int64)
  Name of the excluded worker's manager.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the mass request hierarchy.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "MassRequestExemptionId":{
            "type":"integer",
            "description":"Name of the excluded worker's manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "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 : goalPlans-perfGoalExcludedWorkers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Unique identifier for the assignment of the worker excluded from the goal plan.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the excluded worker's assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the excluded worker.
• AssignmentStatusType: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 30

  Status type for the assignment of the excluded worker.
• BusinessTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 255

  Business title of the excluded worker.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who excluded the worker from the goal plan assignment.
• CreationDate: string (date-time)
  Read Only: true

  Date the worker was excluded from the goal plan assignment.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  Name of the excluded worker's department.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the worker who's excluded from the goal plan assignment.
• LastUpdateDate: string (date-time)
  Read Only: true

  Global user ID of the excluded worker.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date the details of the worker excluded from the goal plan was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerName: string
  Title: Manager Name

  Read Only: true

  Maximum Length: 255

  Name of the person who last updated the details of the worker who's excluded from the goal plan assignment.
• MassRequestExemptionId: integer (int64)
  Name of the excluded worker's manager.
• MassRequestHierarchyId: integer (int64)
  Read Only: true

  Default Value: -1

  Type of manager that excluded the worker.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the mass request hierarchy.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Unique identifier for the mass goal plan assignment.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 255

  Unique identifier for the excluded worker.
• SysEffectiveDate: string (date)

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the goal plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the excluded worker's assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentStatusType":{
            "title":"Assignment Status",
            "maxLength":30,
            "type":"string",
            "description":"Status type for the assignment of the excluded worker.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessTitle":{
            "title":"Job",
            "maxLength":255,
            "type":"string",
            "description":"Business title of the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who excluded the worker from the goal plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the worker was excluded from the goal plan assignment.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":255,
            "type":"string",
            "description":"Name of the excluded worker's department.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the worker who's excluded from the goal plan assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Global user ID of the excluded worker.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date the details of the worker excluded from the goal plan was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the person who last updated the details of the worker who's excluded from the goal plan assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MassRequestExemptionId":{
            "type":"integer",
            "description":"Name of the excluded worker's manager.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "MassRequestHierarchyId":{
            "type":"integer",
            "description":"Type of manager that excluded the worker.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the mass goal plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for the excluded worker.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "format":"date",
            "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