HRhrapi
Positions

Gets a single Position referenced by ID.

Changed on
get/positions/{id}

Request

Path parameters

idstring required

Position ID.

Response

OK

JobTitlestring nullable

The Job Title for this Position.

Cascade Source:[ValidPosts].[JobTitle]

ShortJobTitlestring nullable

A shorter version of the Position's Job Title.

Cascade Source: [ValidPosts].[ShortJobTitle]

ParentIdstring nullable

The ID of the Position that Jobs based on this Position Report To.

Must exist in the Positions Service.

Cascade Source: [ValidPosts].[PostReportsTo]

ParentNamestring nullable

The Name of the Position that Jobs based on this Position Report To.

CascadeSource: [ValidPosts].[PostReportsTo]

DisplayIdstring nullable

The Display ID for this Position.

Cascade Source: [ValidPost].[PostId]

HierarchyNodeIdstring nullable

The Id of the Hierarchy Node for the Position. Must exist in Hierarchy Service.

Contractstring nullable

The Contract for this Position e.g. Full Time, Part Time.

Cascade Source: [ValidPosts].[ContractType] translated through the EMPLOYMENTTYPES system list.

Classificationstring nullable

The classification for this Position e.g. Technical, Professional, Managerial.

Cascade Source: [ValidPosts].[Classification] translated through the JOBCLASSIFICATION system list.

PayGradestring nullable

The pay grade name assigned for this Position.

Cascade Source: [ValidPosts].[PayGrade] which comes from [ValidPayGrade].[Grade]

GradeHoursnumber double nullable

The working house associated with the assigned Pay Grade.

Cascade Source: [ValidPosts].[GradeHours]

NormalHoursnumber double nullable

Normal working hours for this Position.

Cascade Source: [ValidPosts].[NormalHours]

WorkingPatternNamestring nullable

The name of the Working Pattern for this Position.

Cascade Source: [ValidPosts].[WorkingCalendar] which comes from [ValidWorkingCalendar].[CalendarName]

WorkingPatternIdstring nullable

The ID of the Working Pattern of the Position.

Must exist in Working Pattern Service.

StartDatestring date-time nullable

The start date of when the Position can be assigned.

Leave null for unrestricted start.

Cascade Source: [ValidPosts].[StartDate]

StartReasonstring nullable

The reason for starting the Position.

Cascade source: [ValidPosts].[StartReason]

EndDatestring date-time nullable

The end date of when the Position can be assigned.

Leave null for unrestricted end.

Cascade Source: [ValidPosts].[EndDate]

EndReasonstring nullable

The reason for ending the Position.

Cascade Source: [ValidPosts].[EndReason]

Temporaryboolean

Is the Position temporary?

Cascade Source: [ValidPosts].[TemporaryPost]

Typestring nullable

The Position usability Type.

Cascade Source: [ValidPosts].[ShareType]

Capacitynumber double nullable

The number of Employees that can be assigned to this Position.

Cascade Source: [ValidPosts].[Positions]

TotalHoursnumber double nullable

The number of person hours the Position uses.

Cascade Source: [ValidPosts].[TotalHours]

JobFamilystring nullable

The job family of this Position.

Cascade Source: [ValidPosts].[JobFamily] translated through the Job Family system list.

SourceSystemIdinteger

Source HR System Id.

Cascade Source: [ValidPosts].[key]

SourceSystemCreatedOnstring date-time nullable

The date when the Position was created in the Source HR System.

Cascade Source: N/A

SourceSystemLastModifiedOnstring date-time nullable

The date when the Position was created or last updated in the Source HR System.

Cascade Source: N/A

Idstring nullable

The ID of the Position.

This id is generated by the Iris Hr platform and does not relate to the Cascade Id.

CreatedOnstring date-time

The date time when the Position was created in the Iris HR platform.

CreatedBystring nullable

Not used as the Iris HR platform has no concept of users.

LastModifiedOnstring date-time nullable

The date when the Position was created or last updated.

LastModifiedBystring nullable

Not used as Iris HR platform has no concept of users.

Changes

  • 638d402d3872Revision changes
    • breaking

      added the pattern ^[0-9a-fA-F-]{36}$ to the path request parameter id

    • breaking

      removed the media type application/prs.odatatestxx-odata for the response with the status

    • breaking

      removed the media type application/prs.odatatestxx-odata for the response with the status

    • breaking

      removed the media type application/prs.odatatestxx-odata for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • breaking

      removed the media type text/json for the response with the status

    • warning

      for the path request parameter id, the maxLength was set to 36

  • 7a4734dbe370Revision changes
    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json; version=1 was changed to application/json for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full; version=1 was changed to application/json;odata.metadata=full for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=false; version=1 was changed to application/json;odata.metadata=full;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=full;odata.streaming=true; version=1 was changed to application/json;odata.metadata=full;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal; version=1 was changed to application/json;odata.metadata=minimal for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=false; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=minimal;odata.streaming=true; version=1 was changed to application/json;odata.metadata=minimal;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none; version=1 was changed to application/json;odata.metadata=none for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=false; version=1 was changed to application/json;odata.metadata=none;odata.streaming=false for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.metadata=none;odata.streaming=true; version=1 was changed to application/json;odata.metadata=none;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=false; version=1 was changed to application/json;odata.streaming=false for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/json;odata.streaming=true; version=1 was changed to application/json;odata.streaming=true for the response status

    • info

      media type application/prs.odatatestxx-odata; version=1 was changed to application/prs.odatatestxx-odata for the response status

    • info

      media type application/prs.odatatestxx-odata; version=1 was changed to application/prs.odatatestxx-odata for the response status

    • info

      media type application/prs.odatatestxx-odata; version=1 was changed to application/prs.odatatestxx-odata for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type application/xml; version=1 was changed to application/xml for the response status

    • info

      media type text/json; version=1 was changed to text/json for the response status

    • info

      media type text/json; version=1 was changed to text/json for the response status

    • info

      media type text/json; version=1 was changed to text/json for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status

    • info

      media type text/plain; version=1 was changed to text/plain for the response status