Jump to

• Request
• Response

Create an eligibility object profile

post

/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles

Request

Path Parameters

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

Header Parameters

• Effective-Of:
  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:
  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.
• Upsert-Mode:
  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

• EffectiveEndDate: string (date)
  Effective end date for the eligibility object profile.
• EffectiveStartDate: string (date)
  Effective start date for the eligibility object profile.
• EligibilityObjectId: integer (int64)
  Unique identifier of the eligibility object.
• EligibilityObjectProfileId: integer (int64)
  Unique identifier of the eligibility object profile.
• EligibilityProfileId: integer (int64)
  Unique identifier of the eligibility profile.
• MandatoryFlag: boolean
  Maximum Length: 1

  Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.

{
    "type":"object",
    "properties":{
        "EligibilityObjectId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the eligibility object profile.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date for the eligibility object profile.",
            "format":"date",
            "nullable":false
        },
        "EligibilityObjectProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EligibilityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.",
            "nullable":false
        }
    }
}

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 : eligibilityObjects-eligibilityObjectProfiles-item-response

Type: object

Show Source

• EffectiveEndDate: string (date)
  Effective end date for the eligibility object profile.
• EffectiveStartDate: string (date)
  Effective start date for the eligibility object profile.
• EligibilityObjectId: integer (int64)
  Unique identifier of the eligibility object.
• EligibilityObjectProfileId: integer (int64)
  Unique identifier of the eligibility object profile.
• EligibilityProfileId: integer (int64)
  Unique identifier of the eligibility profile.
• EligibilityProfileName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the eligibility object profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Maximum Length: 1

  Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.

{
    "type":"object",
    "properties":{
        "EligibilityObjectId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date for the eligibility object profile.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityProfileName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the eligibility object profile.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date for the eligibility object profile.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityObjectProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EligibilityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the task is mandatory or optional. The valid values are Y and N. The default value is N.",
            "nullable":false,
            "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."
        }
    }
}

Links

eligibilityProfileIdLOV

Operation: /hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EligibilityProfileId; Target Attribute: EligyPrflId
• Display Attribute: Name

Back to Top