Jump to

• Request
• Response

Create an eligibility object result

post

/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults

Request

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

• AssignmentId: integer (int64)
  Unique assignment identifier of the eligibility object result.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Effective end date for the eligibility object result.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Effective start date for the eligibility object result.
• EligibilityObjectId: integer (int64)
  Unique identifier of the eligibility object.
• EligibilityObjectType: string
  Title: Eligibility Object Type

  Maximum Length: 30

  Type of the eligibility object results object.
• EligibilityResultId: integer (int64)
  Unique identifier of the eligibility object result.
• EligibleFlag: boolean
  Title: Eligible

  Maximum Length: 1

  Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value.
• IneligibleReasonCode: string
  Title: Ineligible Reason

  Maximum Length: 30

  Ineligible reason code of the eligibility object result.
• OverrideFlag: boolean
  Title: Overridden

  Maximum Length: 30

  Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N.
• OverrideThruDate: string (date)
  Title: Override Through Date

  Override through date of the eligibility object result.
• PersonId: integer (int64)
  Unique person identifier of the eligibility object result.

{
    "type":"object",
    "properties":{
        "OverrideFlag":{
            "title":"Overridden",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N.",
            "nullable":true
        },
        "EligibilityObjectId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EligibilityObjectType":{
            "title":"Eligibility Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the eligibility object results object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Effective end date for the eligibility object result.",
            "format":"date",
            "nullable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique person identifier of the eligibility object result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IneligibleReasonCode":{
            "title":"Ineligible Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Ineligible reason code of the eligibility object result.",
            "nullable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique assignment identifier of the eligibility object result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EligibilityResultId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EligibleFlag":{
            "title":"Eligible",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value.",
            "nullable":false
        },
        "OverrideThruDate":{
            "title":"Override Through Date",
            "type":"string",
            "description":"Override through date of the eligibility object result.",
            "format":"date",
            "nullable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Effective start date for the eligibility object result.",
            "format":"date",
            "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 : eligibilityObjectResults-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Unique assignment identifier of the eligibility object result.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Assignment number of the eligibility object result.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Effective end date for the eligibility object result.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Effective start date for the eligibility object result.
• EligibilityObjectId: integer (int64)
  Unique identifier of the eligibility object.
• EligibilityObjectType: string
  Title: Eligibility Object Type

  Maximum Length: 30

  Type of the eligibility object results object.
• EligibilityResultId: integer (int64)
  Unique identifier of the eligibility object result.
• EligibleFlag: boolean
  Title: Eligible

  Maximum Length: 1

  Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value.
• IneligibleReasonCode: string
  Title: Ineligible Reason

  Maximum Length: 30

  Ineligible reason code of the eligibility object result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideFlag: boolean
  Title: Overridden

  Maximum Length: 30

  Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N.
• OverrideThruDate: string (date)
  Title: Override Through Date

  Override through date of the eligibility object result.
• PersonId: integer (int64)
  Unique person identifier of the eligibility object result.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the eligibility object result.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the eligibility object result.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideFlag":{
            "title":"Overridden",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the results are based on the override flag. The valid values are Y and N. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "EligibilityObjectType":{
            "title":"Eligibility Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of the eligibility object results object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Effective end date for the eligibility object result.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityResultId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideThruDate":{
            "title":"Override Through Date",
            "type":"string",
            "description":"Override through date of the eligibility object result.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EligibilityObjectId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique person identifier of the eligibility object result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IneligibleReasonCode":{
            "title":"Ineligible Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Ineligible reason code of the eligibility object result.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment number of the eligibility object result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique assignment identifier of the eligibility object result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EligibleFlag":{
            "title":"Eligible",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the results are based on the eligible flag. The valid values are Y and N. It doesn't have a default value.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Effective start date for the eligibility object result.",
            "format":"date",
            "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

BenEligObjectVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DBEN_ELIG_OBJ_TYPE%2CLookupCode%3D{EligibilityObjectType}

The following properties are defined on the LOV link relation:

• Source Attribute: EligibilityObjectType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top