create Person

POST {{base_url}}/V1/persons

Does:

Creates a new Person object in the database. Note that you will not see this Person yet in the Person Manager widget; the Person needs to have at least one PersonGroupMembership for that!

Purpose:

To represent a real-life individual with a number of basic properties.

Change this:

Apart from the obvious readwrite properties, mind the following semantics:

  • the ExternalID property can be freely chosen and is usually the identifier of the person in some source system. MAY be unique.
  • the Tag property helps avoid unwanted duplicity-effects. MAY be any string, but MUST be globally unique if not empty (null).

Note that these two properties may be changed at runtime by end users, therefore various API use the readonly ID starting with G_ that is returned in the response.

Live example:

  • Populates the environment variable TESTPERSON, used in subsequent calls within the same Runner.

Bonus tip:

You can use the G_ ID to jump to any person in the Person Manager widget GUI.

Request Body

{"ExternalID"=>"employee_{{randomNumber}}", "FirstName"=>"{{$randomFirstName}}", "LastName"=>"{{$randomLastName}}", "PreferredLanguage"=>"en", "Tag"=>"{{TPnumber}}-{{persontagcounter}}"}