Jump to

• Request
• Response
• Examples

Get all visas

get

/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/visas

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all employee visas that match the primary key criteria specified.
    Finder Variables
    • VisaPermitId; integer; System-generated primary key. Surrogate key.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AsgResponsibilityId; integer; Primary key autogenerated by the application.
  • AssignmentId; integer; Internal identifier for the assignment.
  • PersonId; integer; Internal unique identifier for the person.
  • ResponsibilityName; string; Name of an area of responsibility.
  • ResponsibilityTypeCode; string; Identifier of the responsibility type for which this record holds the criteria. The value is validated against HCM_LOOKUPS with the lookup type PER_RESPONSIBILITY_TYPES.
  • ResponsibilityTypeName; string; Name of the responsibility type for which this record holds the criteria. For example, Benefits Representative.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreationDate; string; Date and time of creation of the employee role record.
  • EndDate; string; End date of the role.
  • LastUpdateDate; string; Date and time of update of the employee role record.
  • RoleCommonName; string; Short name of the role.
  • RoleGUID; string; Globally unique identifier for the role record in Oracle Cloud. Valid values are defined in the list RoleGUIDLOV.
  • RoleName; string; Name of the role.
  • StartDate; string; Start date of the role.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • PersonId; integer
  • __FLEX_Context; string
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EnabledFlag; string
  • EndDateActive; string
  • StartDateActive; string
  • _ID_FLEX_NUM; integer
  • _PEOPLE_GROUP_ID; integer

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AddressLine1; string; First line of the primary mailing address.
  • AddressLine2; string; Second line of the primary mailing address.
  • AddressLine3; string; Third line of the primary mailing address.
  • CitizenshipId; integer; Primary key autogenerated by the application.
  • CitizenshipLegislationCode; string; Legislation code derived from the legal entity. Valid values are defined in the list CitizenshipLegislationCodeLOV.
  • CitizenshipStatus; string; Status of the person's citizenship. Valid values are defined in the list CitizenshipStatusLOV.
  • CitizenshipToDate; string; End date of citizenship.
  • City; string; Town or city in which the address is located.
  • CorrespondenceLanguage; string; Preferred language for communication. Valid values are defined in the list CorrespondenceLanguageLOV.
  • Country; string; Country in which the address is located.
  • CreationDate; string; Date and time of creation of the employee record.
  • DateOfBirth; string; Date of birth of the person.
  • DisplayName; string; Person's display name.
  • DriversLicenseExpirationDate; string; Expiration date of the driver's license.
  • DriversLicenseId; integer; System-generated primary key. Surrogate key.
  • DriversLicenseIssuingCountry; string; Country that issued the driver's license.
  • EffectiveStartDate; string; Date at the beginning of the period within which the employee is effective.
  • Ethnicity; string; Person's ethnicity for the legislation code. Valid values are defined in the list EthnicityLOV.
  • FirstName; string; Person's first name.
  • Gender; string; Person's gender. Valid values are defined in the list GenderLOV.
  • HireDate; string; Hire date of the employee.
  • HomeFaxAreaCode; string; Area code of the phone number for the home fax machine.
  • HomeFaxCountryCode; string; Country code of the phone number for the home fax machine.
  • HomeFaxExtension; string; Extension of the phone number for the home fax machine.
  • HomeFaxLegislationCode; string; Legislation code of the home fax number.
  • HomeFaxNumber; string; Phone number for the home fax machine.
  • HomePhoneAreaCode; string; Area code of the home phone number.
  • HomePhoneCountryCode; string; Country code of the home phone number.
  • HomePhoneExtension; string; Extension of the home phone number.
  • HomePhoneLegislationCode; string; Legislation code of the home phone number.
  • HomePhoneNumber; string; Home phone number.
  • Honors; string; Higher qualification appended to a person's name. For example, PhD.
  • LastName; string; Person's last name.
  • LastUpdateDate; string; Date and time of update of the employee record.
  • LicenseNumber; string; Person's driving license number.
  • MaritalStatus; string; Person's marital status. Valid values are defined in the list MaritalStatusLOV.
  • MiddleName; string; Person's middle name.
  • MilitaryVetStatus; string; Indicates whether the person is on military service. Valid values are defined in the list MilitaryVetStatusLOV.
  • NameSuffix; string; Part of the name appended to a person's last name.
  • NationalId; string; Primary key autogenerated by the application.
  • NationalIdCountry; string; Country of nationality.
  • NationalIdExpirationDate; string; Expiration date of the national identifier.
  • NationalIdPlaceOfIssue; string; Place where the national identifier was issued.
  • NationalIdType; string; Type of national identifier. Valid values are defined in the list NationalIdTypeLOV.
  • PassportExpirationDate; string; Expiration date of the passport.
  • PassportId; integer; Primary key autogenerated by the application.
  • PassportIssueDate; string; Date of issue of passport.
  • PassportIssuingCountry; string; Country that issued the passport.
  • PassportNumber; string; Person's passport number.
  • PersonId; integer; Internal unique identifier for the person.
  • PersonNumber; string; Number assigned to a person to identify the person uniquely. Doesn't depend on the person type (employee, contingent worker, and so on). Search on this attribute isn't case sensitive.
  • PostalCode; string; Postal code of the address.
  • PreferredName; string; Person's preferred first name.
  • PreviousLastName; string; Previous last name of the person, if any.
  • ProjectedTerminationDate; string; Projected termination date for the worker.
  • Region; string; Primary region in which the address is located.
  • Region2; string; Secondary region within the primary region.
  • Religion; string; Person's religion. Valid values are defined in the list ReligionLOV.
  • ReligionId; integer; Primary key autogenerated by the application.
  • Salutation; string; Person salutation such as Mr., Ms., and so on. Valid values are defined in the list SalutationLOV.
  • TerminationDate; string; Termination date of the employee.
  • UserName; string; User name for the record. This value is optional and is automatically generated if not specified. Also works with UsernameMatching attribute. Search on this attribute isn't case sensitive.
  • WorkEmail; string; Person's work email address. Search on this attribute isn't case sensitive.
  • WorkFaxAreaCode; string; Area code of the phone number for the work fax machine.
  • WorkFaxCountryCode; string; Country code of the phone number for the work fax machine.
  • WorkFaxExtension; string; Extension of the phone number for the work fax machine.
  • WorkFaxLegislationCode; string; Legislation code of the work fax number.
  • WorkFaxNumber; string; Phone number for the home fax machine.
  • WorkMobilePhoneAreaCode; string; Area code of the work mobile phone number.
  • WorkMobilePhoneCountryCode; string; Country code of the work mobile phone number.
  • WorkMobilePhoneExtension; string; Extension of the work mobile phone number.
  • WorkMobilePhoneLegislationCode; string; Legislation code of the work mobile phone number.
  • WorkMobilePhoneNumber; string; Work mobile phone number.
  • WorkPhoneAreaCode; string; Area code of the work phone number.
  • WorkPhoneCountryCode; string; Country code of the work phone number, such as 39 for Italy.
  • WorkPhoneExtension; string; Extension of the work phone number.
  • WorkPhoneLegislationCode; string; Legislation code of the work phone number.
  • WorkPhoneNumber; string; Work phone number.
  • WorkerType; string; Primary type of a worker such as employee (E), contingent worker (C), pending worker (P), or nonworker (N). This is a read-only attribute as indicated in the describe metadata.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • EffectiveStartDate; string; Date at the beginning of the period within which the employee direct report is effective.
  • FullName; string; Full name of the manager.
  • ManagerId; integer; Internal identifier for the manager.
  • PersonId; integer; Internal unique identifier for the person.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentId; integer
  • AssignmentType; string
  • EffectiveEndDate; string
  • EffectiveLatestChange; string
  • EffectiveSequence; integer
  • EffectiveStartDate; string
  • __FLEX_Context; string
  • __FLEX_Context_DisplayValue; string

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionCode; string; Action performed on a particular record, such as Hire, Add Pending Worker, Manager Change, and so on. Valid values are defined in the list ActionCodeLOV.
  • ActionReasonCode; string; User-defined code for the action reason. Specifies the reason for the action performed on the record. Valid values are defined in the list ActionReasonCodeLOV.
  • ActualTerminationDate; string; Actual date of termination of employment. This is required during termination, when the TerminateWorkRelationshipFlag is set to Y.
  • AssignmentCategory; string; User-defined category such as Full-Time Permanent or Part-Time Permanent. Valid values are defined in the list AssignmentCategoryLOV.
  • AssignmentId; integer; Unique identifier for the assignment. This is a primary key generated by the application.
  • AssignmentName; string; Name of the assignment.
  • AssignmentNumber; string; Unique identifier for the assignment or terms. Valid for workers and nonworkers.
  • AssignmentProjectedEndDate; string; Date on which the assignment is expected to end.
  • AssignmentStatus; string; HR status of the assignment, such as Active or Inactive. Valid values are defined in the list AssignmentStatusLOV.
  • AssignmentStatusTypeId; integer; Unique identifier for the user-defined assignment status. Valid values are defined in the list AssignmentStatusTypeIdLOV.
  • BusinessUnitId; integer; Unique identifier for the business unit. Valid values are defined in the list BusinessUnitIdLOV.
  • CreationDate; string; Date and time of creation of the employee assignment record.
  • DepartmentId; integer; Unique identifier for the department. Valid values are defined in the list DepartmentIdLOV.
  • EffectiveEndDate; string; Date at the end of the period within which the employee assignment is effective.
  • EffectiveStartDate; string; Date at the beginning of the period within which the employee assignment is effective.
  • EndTime; string; Workday normal end time.
  • Frequency; string; Frequency of normal working hours such as week, month, year. Valid values are defined in the list FrequencyLOV.
  • FullPartTime; string; Indicates whether the position the employee is hired for is full-time or part-time. Valid values are defined in the list FullPartTimeLOV.
  • GradeId; integer; Unique identifier for the grade. Valid values are defined in the list GradeIdLOV.
  • GradeLadderId; integer; Unique identifier for the grade ladder.
  • JobId; integer; Unique identifier for the job. Valid values are defined in the list JobIdLOV.
  • LastUpdateDate; string; Date and time of update of the employee assignment record.
  • LegalEntityId; integer; Unique identifier for the legal entity.
  • LocationId; integer; Unique identifier for the location. Valid values are defined in the list LocationIdLOV.
  • ManagerAssignmentId; integer; Identifier for the manager's assignment.
  • ManagerId; integer; Unique identifier for a manager. Valid values are defined in the list ManagerIdLOV.
  • ManagerType; string; Role of the manager with regards to the overall organization structure. For example, functional, project leader, and so on.
  • OriginalHireDate; string; Original date of hire for employment.
  • PeopleGroup; string; People group represented as a concatenated value of all the related key flexfield segments.
  • PeriodOfServiceId; integer; Primary key autogenerated by the application.
  • PersonTypeId; integer; Unique identifier for the person type. Valid values are defined in the list PersonTypeIdLOV.
  • PositionId; integer; Unique identifier for a position. Valid values are defined in the list PositionIdLOV.
  • PrimaryAssignmentFlag; boolean; Indicates whether the current assignment is the primary assignment. Valid values are Yes and No.
  • PrimaryWorkRelationFlag; boolean; Indicates whether the current work relationship is primary. Valid values are Yes and No.
  • PrimaryWorkTermsFlag; boolean; Indicates whether the current employment terms are primary. Valid values are Yes and No.
  • ProbationPeriodEndDate; string; End date of the probation period.
  • ProbationPeriodLength; number; Duration of the probation period.
  • ProbationPeriodUnitOfMeasure; string; Units for the probation period duration. Valid values are defined in the list QUALIFYING_UNITS.
  • ProjectedStartDate; string; Proposed start date for the pending worker.
  • ProposedPersonTypeId; string; Unique identifier for the worker class. This value is valid only if the PersonTypeId is Pending Worker. It can be any of the employee or contingent worker types. Valid values are defined in the list ProposedPersonTypeIdLOV.
  • RegularTemporary; string; Indicates whether the position the employee is hired for is regular or temporary. Valid values are defined in the list RegularTemporaryLOV.
  • SalaryAmount; number; Salary amount entered based on the salary frequency.
  • SalaryBasisId; integer; Identifier for the set of details linked to a worker's base pay. It identifies the payroll characteristics used to pay base earnings, the duration for which base pay is quoted, the factor used to annualize base pay, any components used to attribute base pay adjustments to different reasons, and any associated grade rate for salary validation. Valid values are defined in the list SalaryBasisIdLOV.
  • SalaryCode; string; Identifies whether the assignment is paid by the hour or by a salary. Either maintained at the assignment level or employment or placement terms but not both. Valid values are defined in the list SalaryCodeLOV.
  • StartTime; string; Workday normal start time.
  • TermsEffectiveStartDate; string; Date at the beginning of the period within which the employee term is effective.
  • WorkTaxAddressId; integer; Unique identifier for the address that's used for taxation purposes. This can be different from a mailing address. Valid values are defined in the list WorkTaxAddressIdLOV.
  • WorkerCategory; string; Category of the worker such as Blue Collar, Civil Servant, and so on. Valid values are defined in the list WorkerCategoryLOV.
  • WorkingAsManager; string; Indicates whether the person is a manager. Valid values are Yes and No.
  • WorkingAtHome; string; Indicates whether the person is working at home. Valid values are Yes and No.
  • WorkingHours; number; Normal working hours.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreationDate; string; Date and time of creation of the employee visa record.
  • LastUpdateDate; string; Date and time of update of the employee visa record.
  • VisaPermitCountry; string; Country for which visa or permit is valid. Valid values are defined in the list IssuingCountryLOV.
  • VisaPermitExpiration; string; Expiration date of visa or permit.
  • VisaPermitId; integer; Primary key autogenerated by the application.
  • VisaPermitNumber; string; Visa or permit number.
  • VisaPermitType; string; Visa or permit type. Valid values are defined in the list VisaPermitTypeLOV.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Image; string; Unique location of the image. Encrypted version of the file.
  • ImageId; integer; Primary key autogenerated by the application.
  • ImageName; string; Name of the image.
  • ObjectVersionNumber; integer; Used to implement optimistic locking. This number is incremented every time a row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • PersonId; integer; Person associated with the image. Foreign key to PER_ALL_PEOPLE_F.
  • PrimaryFlag; boolean; Indicates whether the image is primary.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : emps-visas

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/emps-visas-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object emps-visas-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/emps-visas-item-response"
    }
}

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 : emps-visas-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time of creation of the employee visa record.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time of update of the employee visa record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• VisaPermitCountry: string
  Title: Issuing Country

  Maximum Length: 30

  Country for which visa or permit is valid. Valid values are defined in the list IssuingCountryLOV.
• VisaPermitExpiration: string (date)
  Title: Expiration Date

  Expiration date of visa or permit.
• VisaPermitId: integer (int64)
  Title: Visa Permit ID

  Primary key autogenerated by the application.
• VisaPermitNumber: string
  Title: Number

  Maximum Length: 30

  Visa or permit number.
• VisaPermitType: string
  Title: Type

  Maximum Length: 30

  Visa or permit type. Valid values are defined in the list VisaPermitTypeLOV.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time of creation of the employee visa record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VisaPermitId":{
            "title":"Visa Permit ID",
            "type":"integer",
            "description":"Primary key autogenerated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "VisaPermitExpiration":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of visa or permit.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "VisaPermitCountry":{
            "title":"Issuing Country",
            "maxLength":"30",
            "type":"string",
            "description":"Country for which visa or permit is valid. Valid values are defined in the list IssuingCountryLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VisaPermitType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Visa or permit type. Valid values are defined in the list VisaPermitTypeLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VisaPermitNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"Visa or permit number.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time of update of the employee visa record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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

Examples

The following example shows how to retrieve information about all employee visas by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/emps/000200000069ACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787200106A6176612E6C616E672E4F626A656374000000000000000000000078707708000000E3C95EA800780000000EACED00057708000110F07AE74780/child/visas

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items" : [2]
    {
    "VisaPermitId" : 300100019168995,
    "VisaPermitType" : "B",
    "VisaPermitCountry" : null,
    "VisaPermitNumber" : "VS12345",
    "VisaPermitExpiration" : null,
    "CreationDate" : "2013-01-09T02:37:42-07:00",
    "LastUpdateDate" : "2013-01-09T02:39:17-07:00",
    "links" : [5]
        0:  {...
            ...}
    },
    {
    "VisaPermitId" : 300100019174555,
    "VisaPermitType" : "B",
    "VisaPermitCountry" : null,
    "VisaPermitNumber" : null,
    "VisaPermitExpiration" : null,
    "CreationDate" : "2013-01-09T02:41:53-07:00",
    "LastUpdateDate" : "2013-01-09T02:54:15-07:00",
    "links" : [5]
        0:  {...
            ...}
    }
}

Back to Top