Jump to

• Request
• Response

Add an excluded worker in the mass assignment process of development goals

post

/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers

Request

Path Parameters

• devGoalsMassAssignProcessUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Development Goals Mass Assignment Process resource and used to uniquely identify an instance of Development Goals Mass Assignment Process. The client should not generate the hash key value. Instead, the client should query on the Development Goals Mass Assignment Process collection resource in order to navigate to a specific instance of Development Goals Mass Assignment Process to get the hash key.

Header Parameters

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

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 mass assignment process of development goals.
• MassRequestExemptionId: integer (int64)
  Unique identifier for the mass request exemption.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the worker excluded from the mass assignment process.

{
    "type":"object",
    "properties":{
        "MassRequestExemptionId":{
            "type":"integer",
            "description":"Unique identifier for the mass request exemption.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the mass assignment process of development goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the worker excluded from the mass assignment process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        }
    }
}

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 : devGoalsMassAssignProcess-devExcludedWorkers-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Unique identifier for the assignment of the worker excluded from the mass assignment process of development goals.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of the assignment of the worker excluded from the mass assignment process of development goals.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the worker excluded from the mass assignment process of development goals.
• AssignmentStatusType: string
  Title: Assignment Status

  Read Only: true

  Maximum Length: 30

  Status type for the assignment of the worker to be excluded from the mass assignment process of development goals.
• BusinessTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 255

  Business title of the worker excluded from the mass assignment process of development goals.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who excluded the worker from the mass assignment process of development goals.
• CreationDate: string (date-time)
  Read Only: true

  Date when the worker was excluded from the mass assignment process.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  Name of the department of the worker excluded from the mass assignment process of development goals.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the worker excluded from the mass assignment process.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the details of the worker excluded from the mass assignment process of development goals was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the person who last updated the details of the worker excluded from the mass assignment process of development goals.
• 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 manager of the worker excluded from the mass assignment process of development goals.
• MassRequestExemptionId: integer (int64)
  Unique identifier for the mass request exemption.
• MassRequestHierarchyId: integer (int64)
  Read Only: true

  Default Value: -1

  Unique identifier for the mass request hierarchy.
• PersonId: integer (int64)
  Title: Person

  Unique identifier for the worker excluded from the mass assignment process.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the worker excluded from the mass assignment process.
• PositionName: string
  Title: Position

  Read Only: true

  Maximum Length: 255

  Name of the position of the worker excluded from the mass assignment process of development goals.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the person who last updated the details of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the worker excluded from the mass assignment process.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MassRequestExemptionId":{
            "type":"integer",
            "description":"Unique identifier for the mass request exemption.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the worker was excluded from the mass assignment process.",
            "format":"date-time",
            "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 mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position",
            "maxLength":255,
            "type":"string",
            "description":"Name of the position of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "MassRequestHierarchyId":{
            "type":"integer",
            "description":"Unique identifier for the mass request hierarchy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the manager of the worker excluded from the mass assignment process of development goals.",
            "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 worker to be excluded from the mass assignment process of development goals.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person",
            "type":"integer",
            "description":"Unique identifier for the worker excluded from the mass assignment process.",
            "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 assignment of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BusinessTitle":{
            "title":"Job",
            "maxLength":255,
            "type":"string",
            "description":"Business title of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the worker excluded from the mass assignment process.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the assignment of the worker excluded from the mass assignment process of development goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":255,
            "type":"string",
            "description":"Name of the department of the worker excluded from the mass assignment process of development goals.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the details of the worker excluded from the mass assignment process of development goals was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        }
    }
}

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