curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/job_architecture/job_families/{job_family_external_id}/profile_data \
  --header 'Authorization: Bearer <token>'
{
  "count": 2,
  "results": [
    {
      "external_id": "5cb55dbe-5444-1233-8157-520f8a2f429a",
      "data_type": "job_family_description",
      "timestamp": "2018-11-07T00:25:00.073876",
      "source": "Workday",
      "data": {
        "job_family_description": "Software engineers are responsible for designing, developing, and testing software. They are involved in the entire software development process, from the initial specification of requirements to the final release of the software."
      }
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "data_type": "job_family_description",
      "timestamp": "2019-09-07T08:21:10.793021",
      "source": "Company-archive",
      "data": {
        "job_family_description": "Software engineers are responsible for writing and testing software. They design and develop software applications and systems."
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
job_family_external_id
string
required

The unique Job Family ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Query Parameters

​
limit
integer
default:100

The maximal number of entities returned, ordered by the last_updated field and external_id.

Required range: 1 <= x <= 200
Example:

50

​
offset
integer
default:0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0

Response

200
application/json
OK
​
count
integer
required

Total number of Job Family Profile Data objects stored inside the system.

Required range: x >= 0
Example:

2

​
results
object[]
required

Subset of Job Family Profile Data starting from offset up to offset + limit.

Default structure for Job Family Profile Data.

Example:
[
  {
    "external_id": "5cb55dbe-5444-1233-8157-520f8a2f429a",
    "data_type": "job_family_description",
    "timestamp": "2018-11-07T00:25:00.073876",
    "source": "Workday",
    "data": {
      "job_family_description": "Software engineers are responsible for designing, developing, and testing software. They are involved in the entire software development process, from the initial specification of requirements to the final release of the software."
    }
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "data_type": "job_family_description",
    "timestamp": "2019-09-07T08:21:10.793021",
    "source": "Company-archive",
    "data": {
      "job_family_description": "Software engineers are responsible for writing and testing software. They design and develop software applications and systems."
    }
  }
]

Was this page helpful?