Purple HRBP API Documentation

POST /api/purple-suite/hrbp/resolve_filters

Resolve & validate HRBP scope filters (tp_resolve_scope)

Parameters

Responses

200

Resolve & validate HRBP scope filters (tp_resolve_scope)

400

Bad request

GET /api/purple-suite/hrbp/available_metrics

List predefined talent metrics (tp_list_metrics)

Parameters

Responses

200

List predefined talent metrics (tp_list_metrics)

400

Bad request

GET /api/purple-suite/hrbp/available_metric_categories

List metric categories

Parameters

Responses

200

List metric categories

400

Bad request

POST /api/purple-suite/hrbp/execute_known_metric

Compute one predefined metric (tp_execute_metric)

Parameters

Responses

200

Compute one predefined metric (tp_execute_metric)

400

Bad request

POST /api/purple-suite/hrbp/find_matching_reviews

Find talent reviews by filters (tp_find_reviews)

Parameters

Responses

200

Find talent reviews by filters (tp_find_reviews)

400

Bad request

POST /api/purple-suite/hrbp/preview_review

Preview a talent review (computes metrics); mints idempotency_key (tp_preview_review)

Parameters

Responses

200

Preview a talent review (computes metrics); mints idempotency_key (tp_preview_review)

400

Bad request

POST /api/purple-suite/hrbp/commit_review

Commit a previewed talent review (tp_commit_review)

Parameters

Responses

200

Commit a previewed talent review (tp_commit_review)

400

Bad request

POST /api/purple-suite/hrbp/add_metric_to_review

Add a metric to an existing talent review (tp_add_metric)

Parameters

Responses

200

Add a metric to an existing talent review (tp_add_metric)

400

Bad request

POST /api/purple-suite/hrbp/display_talent_review

Display a talent review + computed metrics (tp_display_review)

Parameters

Responses

200

Display a talent review + computed metrics (tp_display_review)

400

Bad request

POST /api/purple-suite/hrbp/hrbp_data_analytics/query

HRBP data-analytics query — NL question → generated query, aggregates, inline insights, and async answer/follow-up logIds (SN hrbp_data_analytics/query). Returns 202 on submission; poll result.analysis.logId / result.followUps.logId via /hrbp_data_analytics/async_results.

Parameters

Responses

202

Accepted — async capabilities submitted

400

Validation error (missing required field)

404

getAsyncResults: unknown logId

GET /api/purple-suite/hrbp/hrbp_data_analytics/async_results

Batch-poll async analytics results by logId(s) (SN hrbp_data_analytics/async_results)

Parameters

Responses

200

Batch-poll async analytics results by logId(s) (SN hrbp_data_analytics/async_results)

400

Bad request

POST /api/purple-suite/hrbp/hrbp_action_recommendations_rest_api/recommendations

Generate action recommendations from an analytics finding — accepts {goal, content} or {goal, queryGenResponse|fullpipeline_response} (SN hrbp_action_recommendations_rest_api/recommendations)

Parameters

Responses

200

Generate action recommendations from an analytics finding — accepts {goal, content} or {goal, queryGenResponse|fullpipeline_response} (SN hrbp_action_recommendations_rest_api/recommendations)

400

Bad request

POST /api/purple-suite/hrbp/query

Alias of /hrbp_data_analytics/query (pre-existing Purple path)

Parameters

Responses

200

Alias of /hrbp_data_analytics/query (pre-existing Purple path)

400

Bad request

GET /api/purple-suite/hrbp/async_results

Alias of /hrbp_data_analytics/async_results (pre-existing Purple path)

Parameters

Responses

200

Alias of /hrbp_data_analytics/async_results (pre-existing Purple path)

400

Bad request

POST /api/purple-suite/hrbp/recommendations

Alias of /hrbp_action_recommendations_rest_api/recommendations (pre-existing Purple path)

Parameters

Responses

200

Alias of /hrbp_action_recommendations_rest_api/recommendations (pre-existing Purple path)

400

Bad request

GET /api/purple-suite/hrbp/fuzzy_value_resolver

Resolve a raw value to catalog {value, sys_id} matches via exact->startswith->contains->fuzzy->text cascade (SN FuzzyValueResolver parity)

Parameters

Responses

200

Resolve a raw value to catalog {value, sys_id} matches via exact->startswith->contains->fuzzy->text cascade (SN FuzzyValueResolver parity)

400

Bad request

GET /api/purple-suite/hrbp/available_templates

List talent-review templates

Parameters

Responses

200

List talent-review templates

400

Bad request

POST /api/purple-suite/hrbp/create_review_from_template

Create a talent review from a template (direct write)

Parameters

Responses

200

Create a talent review from a template (direct write)

400

Bad request

POST /api/purple-suite/hrbp/search_talent_reviews

Search talent reviews by filter names + scope; returns templates

Parameters

Responses

200

Search talent reviews by filter names + scope; returns templates

400

Bad request

POST /api/purple-suite/hrbp/execute_talent_review

Execute a talent review's stored metrics by id

Parameters

Responses

200

Execute a talent review's stored metrics by id

400

Bad request

POST /api/purple-suite/hrbp/query_metric

Resolve filters + compute one metric widget

Parameters

Responses

200

Resolve filters + compute one metric widget

400

Bad request

GET /api/purple-suite/hrbp/hr_program/summary

Get an HR program summary by name keyword (q)

Parameters

Responses

200

Get an HR program summary by name keyword (q)

400

Bad request

POST /api/purple-suite/hrbp/hr_program/draft_notification

Raw program data + stakeholder contacts for an LLM to draft an HR program notification from (no server-built draft text)

Parameters

Responses

200

Raw program data + stakeholder contacts for an LLM to draft an HR program notification from (no server-built draft text)

400

Bad request

POST /api/purple-suite/hrbp/hr_program/get_draft

Retrieve the caller's persisted notification draft HTML for a program

Parameters

Responses

200

Retrieve the caller's persisted notification draft HTML for a program

400

Bad request

POST /api/purple-suite/hrbp/hr_program/save_draft

Persist the caller's notification draft HTML for a program

Parameters

Responses

200

Persist the caller's notification draft HTML for a program

400

Bad request

GET /api/purple-suite/hrbp/hr_program/program_details/{sys_id_csv}

Full nested detail (fields, program type, milestones, resources, stakeholders, action plans) for one or more programs by comma-separated sys_id

Parameters

Responses

200

Full nested detail (fields, program type, milestones, resources, stakeholders, action plans) for one or more programs by comma-separated sys_id

400

Bad request

GET /api/purple-suite/hrbp/hr_program

List the caller's stakeholder/owner programs, grouped by state with upcoming milestones

Parameters

Responses

200

List the caller's stakeholder/owner programs, grouped by state with upcoming milestones

400

Bad request

GET /api/purple-suite/hrbp/hr_profile/new_hire

New hires within the calling HRBP's scope for a hire-date window (start_date/end_date, yyyy-MM-dd; defaults to the last 30 days). Returns { start_date, end_date, count, employees:[{ name, hire_date, days_since_hire, position, department, manager }] }, wrapped in {result:...} (SN HRBPNewHireDetailsSNC parity).

Parameters

Responses

200

New hires within the calling HRBP's scope for a hire-date window (start_date/end_date, yyyy-MM-dd; defaults to the last 30 days). Returns { start_date, end_date, count, employees:[{ name, hire_date, days_since_hire, position, department, manager }] }, wrapped in {result:...} (SN HRBPNewHireDetailsSNC parity).

400

Bad request

GET /api/purple-suite/hrbp/employee/{sys_id}/work_history

An employee's job/position history (tenure duration + current-job status), most recent first, by employee sys_id. NOT self-scoped — any internal-role caller may look up any employee. Wraps both success AND error bodies in {result:...} (its SN op routes every 200/400/500 path through response.setBody(), same precedent as /hr_profile/new_hire).

Parameters

Responses

200

An employee's job/position history (tenure duration + current-job status), most recent first, by employee sys_id. NOT self-scoped — any internal-role caller may look up any employee. Wraps both success AND error bodies in {result:...} (its SN op routes every 200/400/500 path through response.setBody(), same precedent as /hr_profile/new_hire).

400

Bad request

GET /api/purple-suite/hrbp/hr_case

List the caller's HRBP cases (paginated, AI-enriched)

Parameters

Responses

200

List the caller's HRBP cases (paginated, AI-enriched)

400

Bad request

GET /api/purple-suite/hrbp/hr_case/{sys_id}

Get full HR case detail + AI enrichment + approvers (with raw_state) + collaborators + meeting_attendees + pending-approval flag

Parameters

Responses

200

Get full HR case detail + AI enrichment + approvers (with raw_state) + collaborators + meeting_attendees + pending-approval flag

400

Bad request

POST /api/purple-suite/hrbp/hr_case/{sys_id}/approval

Approve or reject the caller's pending approval on an HR case

Parameters

Responses

200

Approve or reject the caller's pending approval on an HR case

400

Bad request

GET /api/purple-suite/hrbp/api/now/table/sn_hr_core_case

ServiceNow Table API parity: look up a case by number (sysparm_query=number=<value>); wraps in {result: [...]}

Parameters

Responses

200

ServiceNow Table API parity: look up a case by number (sysparm_query=number=<value>); wraps in {result: [...]}

400

Bad request

PATCH /api/purple-suite/hrbp/api/now/table/sn_hr_core_case/{sys_id}

ServiceNow Table API parity: update a case's state (+ optional work_notes) for defer(24)/resume(18)/cancel(7); wraps in {result: {...}}

Parameters

Responses

200

ServiceNow Table API parity: update a case's state (+ optional work_notes) for defer(24)/resume(18)/cancel(7); wraps in {result: {...}}

400

Bad request

GET /api/purple-suite/hrbp/api/now/table/sys_user

ServiceNow Table API parity: sys_user lookup (sysparm_query=nameLIKE<term>) for the u_SysUser slot resolver; wraps in {result: [...]}

Parameters

Responses

200

ServiceNow Table API parity: sys_user lookup (sysparm_query=nameLIKE<term>) for the u_SysUser slot resolver; wraps in {result: [...]}

400

Bad request

GET /api/purple-suite/hrbp/api/now/table/sn_hr_core_employee_certification_and_license

ServiceNow Table API parity: an employee's certification/license records (sysparm_query=employee=<sys_id>^active=true). Supports the dot-walked certification_or_license.governing_agency field via sysparm_fields; wraps in {result: [...]}. Always shaped as sysparm_display_value=true + sysparm_exclude_reference_link=true (the emulated action sends both as true; not a toggle here — see README).

Parameters

Responses

200

ServiceNow Table API parity: an employee's certification/license records (sysparm_query=employee=<sys_id>^active=true). Supports the dot-walked certification_or_license.governing_agency field via sysparm_fields; wraps in {result: [...]}. Always shaped as sysparm_display_value=true + sysparm_exclude_reference_link=true (the emulated action sends both as true; not a toggle here — see README).

400

Bad request

GET /api/purple-suite/hrbp/api/now/table/sn_hr_core_profile

ServiceNow Table API parity: look up an employee's HR profile by name (sysparm_query=user.name=<value>); reference fields (user.department/user.manager/user.location) as {display_value, link}; wraps in {result: [...]}

Parameters

Responses

200

ServiceNow Table API parity: look up an employee's HR profile by name (sysparm_query=user.name=<value>); reference fields (user.department/user.manager/user.location) as {display_value, link}; wraps in {result: [...]}

400

Bad request

GET /api/purple-suite/hrbp/api/now/table/sys_user_has_skill

ServiceNow Table API parity: list an employee's skills by sys_id (sysparm_query=user.sys_id=<value>); skill/skill_level as {display_value, link} (skill_level is "" when unset); wraps in {result: [...]}

Parameters

Responses

200

ServiceNow Table API parity: list an employee's skills by sys_id (sysparm_query=user.sys_id=<value>); skill/skill_level as {display_value, link} (skill_level is "" when unset); wraps in {result: [...]}

400

Bad request

GET /api/purple-suite/hrbp/er_cases

Look up an ER case by number, or count ER cases by allegation type / department / location / leader / hr_service / date range (SN HRERCaseAPI parity)

Parameters

Responses

200

Look up an ER case by number, or count ER cases by allegation type / department / location / leader / hr_service / date range (SN HRERCaseAPI parity)

400

Bad request

GET /api/purple-suite/hrbp/hrbp_batch_user_resolution/resolve

Batch resolve user names to emails for meeting scheduling (SN hrbp_batch_user_resolution parity)

Parameters

Responses

200

Batch resolve user names to emails for meeting scheduling (SN hrbp_batch_user_resolution parity)

400

Bad request

GET /api/purple-suite/hrbp/hrbp_capabilities

Which optional HRBP Hub modules (e.g. Talent Pulse) are available on this instance (SN hrbp_capabilities parity)

Parameters

Responses

200

Which optional HRBP Hub modules (e.g. Talent Pulse) are available on this instance (SN hrbp_capabilities parity)

400

Bad request

GET /api/purple-suite/hrbp/hrbp_manager_span

Manager span of control. With manager_sys_id: that manager's direct + total (transitive) report counts — {manager_sys_id, num_direct_reports, num_total_reports}, 404 if no such user, zeroes if they are not an active manager. Without it: the CALLING HRBP's in-scope managers ranked by total reports, paginated 10 per page — {page_number, count, managers, average_total_reports} (count is this page's size); never accepts a caller-supplied hrbpSysId. Wraps success AND error bodies in {result:...} (every branch of the SN op routes through response.setBody()).

Parameters

Responses

200

Manager span of control. With manager_sys_id: that manager's direct + total (transitive) report counts — {manager_sys_id, num_direct_reports, num_total_reports}, 404 if no such user, zeroes if they are not an active manager. Without it: the CALLING HRBP's in-scope managers ranked by total reports, paginated 10 per page — {page_number, count, managers, average_total_reports} (count is this page's size); never accepts a caller-supplied hrbpSysId. Wraps success AND error bodies in {result:...} (every branch of the SN op routes through response.setBody()).

400

Bad request

GET /api/purple-suite/hrbp/talent_reviews

List talent reviews

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  TalentReview

  • id string
  • number string
  • name string required
  • state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
  • period_start string
  • period_end string
  • leaders array — Employee IDs leading this review (SN leaders→sys_user).
    Employee IDs leading this review (SN leaders→sys_user).

    array of:

    string

  • departments array — Department names in scope.
    Department names in scope.

    array of:

    string

  • locations array — Locations in scope.
    Locations in scope.

    array of:

    string

  • template_id string
  • objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
  • metrics array — Metrics attached to the review.
    Metrics attached to the review.

    array of:

    • metric_id string
    • group_by string
    • aggregation string
    • order integer
    • insights string
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/talent_reviews

Create a talent review record directly

Parameters

Request body

application/json — required

TalentReview

• id string
• number string
• name string required
• state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
• period_start string
• period_end string
• leaders array — Employee IDs leading this review (SN leaders→sys_user).
  Employee IDs leading this review (SN leaders→sys_user).

  array of:

  string

• departments array — Department names in scope.
  Department names in scope.

  array of:

  string

• locations array — Locations in scope.
  Locations in scope.

  array of:

  string

• template_id string
• objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
• metrics array — Metrics attached to the review.
  Metrics attached to the review.

  array of:

  • metric_id string
  • group_by string
  • aggregation string
  • order integer
  • insights string
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

TalentReview

• id string
• number string
• name string required
• state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
• period_start string
• period_end string
• leaders array — Employee IDs leading this review (SN leaders→sys_user).
  Employee IDs leading this review (SN leaders→sys_user).

  array of:

  string

• departments array — Department names in scope.
  Department names in scope.

  array of:

  string

• locations array — Locations in scope.
  Locations in scope.

  array of:

  string

• template_id string
• objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
• metrics array — Metrics attached to the review.
  Metrics attached to the review.

  array of:

  • metric_id string
  • group_by string
  • aggregation string
  • order integer
  • insights string
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/talent_reviews/{id}

Get a talent review by id

Parameters

Responses

200

Found

application/json

TalentReview

• id string
• number string
• name string required
• state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
• period_start string
• period_end string
• leaders array — Employee IDs leading this review (SN leaders→sys_user).
  Employee IDs leading this review (SN leaders→sys_user).

  array of:

  string

• departments array — Department names in scope.
  Department names in scope.

  array of:

  string

• locations array — Locations in scope.
  Locations in scope.

  array of:

  string

• template_id string
• objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
• metrics array — Metrics attached to the review.
  Metrics attached to the review.

  array of:

  • metric_id string
  • group_by string
  • aggregation string
  • order integer
  • insights string
• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/talent_reviews/{id}

Delete a talent review

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/talent_reviews/{id}

Edit a talent review record

Parameters

Request body

application/json

TalentReview

• id string
• number string
• name string required
• state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
• period_start string
• period_end string
• leaders array — Employee IDs leading this review (SN leaders→sys_user).
  Employee IDs leading this review (SN leaders→sys_user).

  array of:

  string

• departments array — Department names in scope.
  Department names in scope.

  array of:

  string

• locations array — Locations in scope.
  Locations in scope.

  array of:

  string

• template_id string
• objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
• metrics array — Metrics attached to the review.
  Metrics attached to the review.

  array of:

  • metric_id string
  • group_by string
  • aggregation string
  • order integer
  • insights string
• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

TalentReview

• id string
• number string
• name string required
• state string — Lifecycle (forward-only; SN label 'In Progress' → 'in_progress').
• period_start string
• period_end string
• leaders array — Employee IDs leading this review (SN leaders→sys_user).
  Employee IDs leading this review (SN leaders→sys_user).

  array of:

  string

• departments array — Department names in scope.
  Department names in scope.

  array of:

  string

• locations array — Locations in scope.
  Locations in scope.

  array of:

  string

• template_id string
• objectives string — Review objective(s) (e.g. 'Identify retention risks in high-growth hubs').
• metrics array — Metrics attached to the review.
  Metrics attached to the review.

  array of:

  • metric_id string
  • group_by string
  • aggregation string
  • order integer
  • insights string
• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/employee_assessments

List 9-box employee assessments

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  EmployeeAssessment

  • id string
  • employee_id string required
  • talent_review_id string
  • assessment_date string
  • cycle string
  • performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
  • performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
  • potential string — SN 10/20/30 or High/Medium/Low.
  • achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
  • flight_risk string — Stored (not derived) per SN assessment.
  • replacement_readiness string — SN 0/3/6/12.
  • box integer — Derived 9-box cell (potential × performance).
  • core_competencies string
  • development_needs string
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/employee_assessments

Create an employee assessment (9-box datapoint)

Parameters

Request body

application/json — required

EmployeeAssessment

• id string
• employee_id string required
• talent_review_id string
• assessment_date string
• cycle string
• performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
• performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
• potential string — SN 10/20/30 or High/Medium/Low.
• achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
• flight_risk string — Stored (not derived) per SN assessment.
• replacement_readiness string — SN 0/3/6/12.
• box integer — Derived 9-box cell (potential × performance).
• core_competencies string
• development_needs string
• createdAt string
• updatedAt string

Responses

201

Created

application/json

EmployeeAssessment

• id string
• employee_id string required
• talent_review_id string
• assessment_date string
• cycle string
• performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
• performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
• potential string — SN 10/20/30 or High/Medium/Low.
• achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
• flight_risk string — Stored (not derived) per SN assessment.
• replacement_readiness string — SN 0/3/6/12.
• box integer — Derived 9-box cell (potential × performance).
• core_competencies string
• development_needs string
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/employee_assessments/{id}

Get an employee assessment by id

Parameters

Responses

200

Found

application/json

EmployeeAssessment

• id string
• employee_id string required
• talent_review_id string
• assessment_date string
• cycle string
• performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
• performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
• potential string — SN 10/20/30 or High/Medium/Low.
• achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
• flight_risk string — Stored (not derived) per SN assessment.
• replacement_readiness string — SN 0/3/6/12.
• box integer — Derived 9-box cell (potential × performance).
• core_competencies string
• development_needs string
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/employee_assessments/{id}

Delete an employee assessment

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/employee_assessments/{id}

Edit an employee assessment

Parameters

Request body

application/json

EmployeeAssessment

• id string
• employee_id string required
• talent_review_id string
• assessment_date string
• cycle string
• performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
• performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
• potential string — SN 10/20/30 or High/Medium/Low.
• achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
• flight_risk string — Stored (not derived) per SN assessment.
• replacement_readiness string — SN 0/3/6/12.
• box integer — Derived 9-box cell (potential × performance).
• core_competencies string
• development_needs string
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

EmployeeAssessment

• id string
• employee_id string required
• talent_review_id string
• assessment_date string
• cycle string
• performance_rating integer — 1–5 (SN current_performance_level 10–50 / current_rating 30/40/50).
• performance_band string — Derived band (excellent/good/average/needs_improvement/poor).
• potential string — SN 10/20/30 or High/Medium/Low.
• achievable_level string — SN 10/20/30 or '1/2/3 Levels'.
• flight_risk string — Stored (not derived) per SN assessment.
• replacement_readiness string — SN 0/3/6/12.
• box integer — Derived 9-box cell (potential × performance).
• core_competencies string
• development_needs string
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/performance_reviews

List performance review ratings

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  PerformanceReview

  • id string
  • employee_id string required
  • review_start_date string
  • review_end_date string
  • rating_manager number
  • rating_employee number
  • assessed_on string
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/performance_reviews

Create a performance review rating

Parameters

Request body

application/json — required

PerformanceReview

• id string
• employee_id string required
• review_start_date string
• review_end_date string
• rating_manager number
• rating_employee number
• assessed_on string
• createdAt string
• updatedAt string

Responses

201

Created

application/json

PerformanceReview

• id string
• employee_id string required
• review_start_date string
• review_end_date string
• rating_manager number
• rating_employee number
• assessed_on string
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/performance_reviews/{id}

Get a performance review rating by id

Parameters

Responses

200

Found

application/json

PerformanceReview

• id string
• employee_id string required
• review_start_date string
• review_end_date string
• rating_manager number
• rating_employee number
• assessed_on string
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/performance_reviews/{id}

Delete a performance review rating

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/performance_reviews/{id}

Edit a performance review rating

Parameters

Request body

application/json

PerformanceReview

• id string
• employee_id string required
• review_start_date string
• review_end_date string
• rating_manager number
• rating_employee number
• assessed_on string
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

PerformanceReview

• id string
• employee_id string required
• review_start_date string
• review_end_date string
• rating_manager number
• rating_employee number
• assessed_on string
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/succession_plans

List succession plans for critical roles

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  SuccessionPlan

  • id string
  • number string
  • title string required
  • incumbent_employee_id string
  • job_title string
  • department string
  • planned_retirement_date string
  • criticality string — SN demo low/medium/high.
  • loss_impact string — SN High/Intermediate→medium/Low.
  • retention_risk string
  • success_profile object — Role mission/skills/qualifications (SN JSON).
  • successor_count integer
  • external_id string
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/succession_plans

Create a succession plan for a role

Parameters

Request body

application/json — required

SuccessionPlan

• id string
• number string
• title string required
• incumbent_employee_id string
• job_title string
• department string
• planned_retirement_date string
• criticality string — SN demo low/medium/high.
• loss_impact string — SN High/Intermediate→medium/Low.
• retention_risk string
• success_profile object — Role mission/skills/qualifications (SN JSON).
• successor_count integer
• external_id string
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

SuccessionPlan

• id string
• number string
• title string required
• incumbent_employee_id string
• job_title string
• department string
• planned_retirement_date string
• criticality string — SN demo low/medium/high.
• loss_impact string — SN High/Intermediate→medium/Low.
• retention_risk string
• success_profile object — Role mission/skills/qualifications (SN JSON).
• successor_count integer
• external_id string
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/succession_plans/{id}

Get a succession plan by id

Parameters

Responses

200

Found

application/json

SuccessionPlan

• id string
• number string
• title string required
• incumbent_employee_id string
• job_title string
• department string
• planned_retirement_date string
• criticality string — SN demo low/medium/high.
• loss_impact string — SN High/Intermediate→medium/Low.
• retention_risk string
• success_profile object — Role mission/skills/qualifications (SN JSON).
• successor_count integer
• external_id string
• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/succession_plans/{id}

Delete a succession plan

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/succession_plans/{id}

Edit a succession plan

Parameters

Request body

application/json

SuccessionPlan

• id string
• number string
• title string required
• incumbent_employee_id string
• job_title string
• department string
• planned_retirement_date string
• criticality string — SN demo low/medium/high.
• loss_impact string — SN High/Intermediate→medium/Low.
• retention_risk string
• success_profile object — Role mission/skills/qualifications (SN JSON).
• successor_count integer
• external_id string
• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

SuccessionPlan

• id string
• number string
• title string required
• incumbent_employee_id string
• job_title string
• department string
• planned_retirement_date string
• criticality string — SN demo low/medium/high.
• loss_impact string — SN High/Intermediate→medium/Low.
• retention_risk string
• success_profile object — Role mission/skills/qualifications (SN JSON).
• successor_count integer
• external_id string
• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/successors

List succession candidates

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  Successor

  • id string
  • succession_plan_id string required
  • candidate_employee_id string required
  • top_candidate boolean
  • readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
  • potential string
  • achievable_level string
  • current_rating string — Banded (SN '4 - Exceeds Expectations').
  • education string
  • skills string — Comma-separated.
  • job_history_companies string
  • promotion_readiness string
  • development_areas string
  • matching_score integer
  • candidate_profile object — Per-dimension match scores (SN JSON).
  • temporary_fill boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/successors

Add a candidate to a succession plan

Parameters

Request body

application/json — required

Successor

• id string
• succession_plan_id string required
• candidate_employee_id string required
• top_candidate boolean
• readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
• potential string
• achievable_level string
• current_rating string — Banded (SN '4 - Exceeds Expectations').
• education string
• skills string — Comma-separated.
• job_history_companies string
• promotion_readiness string
• development_areas string
• matching_score integer
• candidate_profile object — Per-dimension match scores (SN JSON).
• temporary_fill boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

Successor

• id string
• succession_plan_id string required
• candidate_employee_id string required
• top_candidate boolean
• readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
• potential string
• achievable_level string
• current_rating string — Banded (SN '4 - Exceeds Expectations').
• education string
• skills string — Comma-separated.
• job_history_companies string
• promotion_readiness string
• development_areas string
• matching_score integer
• candidate_profile object — Per-dimension match scores (SN JSON).
• temporary_fill boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/successors/{id}

Get a succession candidate by id

Parameters

Responses

200

Found

application/json

Successor

• id string
• succession_plan_id string required
• candidate_employee_id string required
• top_candidate boolean
• readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
• potential string
• achievable_level string
• current_rating string — Banded (SN '4 - Exceeds Expectations').
• education string
• skills string — Comma-separated.
• job_history_companies string
• promotion_readiness string
• development_areas string
• matching_score integer
• candidate_profile object — Per-dimension match scores (SN JSON).
• temporary_fill boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/successors/{id}

Remove a candidate from a succession plan

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/successors/{id}

Edit a succession candidate

Parameters

Request body

application/json

Successor

• id string
• succession_plan_id string required
• candidate_employee_id string required
• top_candidate boolean
• readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
• potential string
• achievable_level string
• current_rating string — Banded (SN '4 - Exceeds Expectations').
• education string
• skills string — Comma-separated.
• job_history_companies string
• promotion_readiness string
• development_areas string
• matching_score integer
• candidate_profile object — Per-dimension match scores (SN JSON).
• temporary_fill boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

Successor

• id string
• succession_plan_id string required
• candidate_employee_id string required
• top_candidate boolean
• readiness string — SN 0/3/6/12 or 'Ready in …' (9 months→6m).
• potential string
• achievable_level string
• current_rating string — Banded (SN '4 - Exceeds Expectations').
• education string
• skills string — Comma-separated.
• job_history_companies string
• promotion_readiness string
• development_areas string
• matching_score integer
• candidate_profile object — Per-dimension match scores (SN JSON).
• temporary_fill boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/snapshots

List captured metric snapshots

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  Snapshot

  • id string
  • metric_id string required
  • group_id string — Batch grouping key.
  • source string
  • value object required — Computed metric value as JSON (per group).
  • timestamp string
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/snapshots

Capture a metric snapshot

Parameters

Request body

application/json — required

Snapshot

• id string
• metric_id string required
• group_id string — Batch grouping key.
• source string
• value object required — Computed metric value as JSON (per group).
• timestamp string
• createdAt string
• updatedAt string

Responses

201

Created

application/json

Snapshot

• id string
• metric_id string required
• group_id string — Batch grouping key.
• source string
• value object required — Computed metric value as JSON (per group).
• timestamp string
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/snapshots/{id}

Get a metric snapshot by id

Parameters

Responses

200

Found

application/json

Snapshot

• id string
• metric_id string required
• group_id string — Batch grouping key.
• source string
• value object required — Computed metric value as JSON (per group).
• timestamp string
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/snapshots/{id}

Delete a metric snapshot

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/snapshots/{id}

Edit a metric snapshot

Parameters

Request body

application/json

Snapshot

• id string
• metric_id string required
• group_id string — Batch grouping key.
• source string
• value object required — Computed metric value as JSON (per group).
• timestamp string
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

Snapshot

• id string
• metric_id string required
• group_id string — Batch grouping key.
• source string
• value object required — Computed metric value as JSON (per group).
• timestamp string
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/metric_goals

List metric goals (targets and thresholds)

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  MetricGoal

  • id string
  • name string
  • talent_review_id string
  • metric_id string required
  • period_start string
  • period_end string
  • threshold_value number
  • comparison_type string
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/metric_goals

Create a metric goal

Parameters

Request body

application/json — required

MetricGoal

• id string
• name string
• talent_review_id string
• metric_id string required
• period_start string
• period_end string
• threshold_value number
• comparison_type string
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

MetricGoal

• id string
• name string
• talent_review_id string
• metric_id string required
• period_start string
• period_end string
• threshold_value number
• comparison_type string
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/metric_goals/{id}

Get a metric goal by id

Parameters

Responses

200

Found

application/json

MetricGoal

• id string
• name string
• talent_review_id string
• metric_id string required
• period_start string
• period_end string
• threshold_value number
• comparison_type string
• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/metric_goals/{id}

Delete a metric goal

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/metric_goals/{id}

Edit a metric goal

Parameters

Request body

application/json

MetricGoal

• id string
• name string
• talent_review_id string
• metric_id string required
• period_start string
• period_end string
• threshold_value number
• comparison_type string
• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

MetricGoal

• id string
• name string
• talent_review_id string
• metric_id string required
• period_start string
• period_end string
• threshold_value number
• comparison_type string
• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/hrbp_scope_assignments

List HRBP scope assignments (who can see what)

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  HrbpScopeAssignment

  • id string
  • user string required — User (email/employee id) this scope grants visibility to.
  • scope_type string
  • scope_id string — Optional link to an HrbpScope (normalized scope definition).
  • all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
  • leaders array — Leader employee IDs in scope.
    Leader employee IDs in scope.

    array of:

    string

  • departments array — Departments in scope.
    Departments in scope.

    array of:

    string

  • locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
    Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

    array of:

    string

  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/hrbp_scope_assignments

Grant an HRBP access to a scope

Parameters

Request body

application/json — required

HrbpScopeAssignment

• id string
• user string required — User (email/employee id) this scope grants visibility to.
• scope_type string
• scope_id string — Optional link to an HrbpScope (normalized scope definition).
• all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
• leaders array — Leader employee IDs in scope.
  Leader employee IDs in scope.

  array of:

  string

• departments array — Departments in scope.
  Departments in scope.

  array of:

  string

• locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
  Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

  array of:

  string

• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

HrbpScopeAssignment

• id string
• user string required — User (email/employee id) this scope grants visibility to.
• scope_type string
• scope_id string — Optional link to an HrbpScope (normalized scope definition).
• all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
• leaders array — Leader employee IDs in scope.
  Leader employee IDs in scope.

  array of:

  string

• departments array — Departments in scope.
  Departments in scope.

  array of:

  string

• locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
  Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

  array of:

  string

• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/hrbp_scope_assignments/{id}

Get an HRBP scope assignment by id

Parameters

Responses

200

Found

application/json

HrbpScopeAssignment

• id string
• user string required — User (email/employee id) this scope grants visibility to.
• scope_type string
• scope_id string — Optional link to an HrbpScope (normalized scope definition).
• all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
• leaders array — Leader employee IDs in scope.
  Leader employee IDs in scope.

  array of:

  string

• departments array — Departments in scope.
  Departments in scope.

  array of:

  string

• locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
  Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

  array of:

  string

• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/hrbp_scope_assignments/{id}

Revoke an HRBP scope assignment

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/hrbp_scope_assignments/{id}

Edit an HRBP scope assignment

Parameters

Request body

application/json

HrbpScopeAssignment

• id string
• user string required — User (email/employee id) this scope grants visibility to.
• scope_type string
• scope_id string — Optional link to an HrbpScope (normalized scope definition).
• all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
• leaders array — Leader employee IDs in scope.
  Leader employee IDs in scope.

  array of:

  string

• departments array — Departments in scope.
  Departments in scope.

  array of:

  string

• locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
  Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

  array of:

  string

• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

HrbpScopeAssignment

• id string
• user string required — User (email/employee id) this scope grants visibility to.
• scope_type string
• scope_id string — Optional link to an HrbpScope (normalized scope definition).
• all_access boolean — Unrestricted (admin-equivalent) scope — request passes through verbatim.
• leaders array — Leader employee IDs in scope.
  Leader employee IDs in scope.

  array of:

  string

• departments array — Departments in scope.
  Departments in scope.

  array of:

  string

• locations array — Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).
  Hierarchical geo scope: region / country / city tokens (a region token covers all its countries & cities).

  array of:

  string

• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/hrbp_scopes

List HRBP scopes (named population definitions)

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  HrbpScope

  Named HRBP scope (SN sn_talent_pulse_hrbp_scope). Composed of HrbpScopeRule rows; assignments reference it by scope_id.
  • id string
  • name string required
  • description string
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/hrbp_scopes

Create an HRBP scope

Parameters

Request body

application/json — required

HrbpScope

• id string
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

HrbpScope

Named HRBP scope (SN sn_talent_pulse_hrbp_scope). Composed of HrbpScopeRule rows; assignments reference it by scope_id.

• id string
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/hrbp_scopes/{id}

Get an HRBP scope by id

Parameters

Responses

200

Found

application/json

HrbpScope

Named HRBP scope (SN sn_talent_pulse_hrbp_scope). Composed of HrbpScopeRule rows; assignments reference it by scope_id.

• id string
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/hrbp_scopes/{id}

Delete an HRBP scope

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/hrbp_scopes/{id}

Edit an HRBP scope

Parameters

Request body

application/json

HrbpScope

• id string
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

HrbpScope

Named HRBP scope (SN sn_talent_pulse_hrbp_scope). Composed of HrbpScopeRule rows; assignments reference it by scope_id.

• id string
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/hrbp_scope_rules

List HRBP scope membership rules

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  HrbpScopeRule

  A single dimension rule within an HrbpScope (SN sn_talent_pulse_hrbp_scope_rule).
  • id string
  • scope_id string required — Parent HrbpScope id.
  • dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
  • value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/hrbp_scope_rules

Add a membership rule to an HRBP scope

Parameters

Request body

application/json — required

HrbpScopeRule

• id string
• scope_id string required — Parent HrbpScope id.
• dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
• value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

HrbpScopeRule

A single dimension rule within an HrbpScope (SN sn_talent_pulse_hrbp_scope_rule).

• id string
• scope_id string required — Parent HrbpScope id.
• dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
• value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/hrbp_scope_rules/{id}

Get an HRBP scope rule by id

Parameters

Responses

200

Found

application/json

HrbpScopeRule

A single dimension rule within an HrbpScope (SN sn_talent_pulse_hrbp_scope_rule).

• id string
• scope_id string required — Parent HrbpScope id.
• dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
• value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
• active boolean
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/hrbp_scope_rules/{id}

Delete an HRBP scope rule

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/hrbp_scope_rules/{id}

Edit an HRBP scope rule

Parameters

Request body

application/json

HrbpScopeRule

• id string
• scope_id string required — Parent HrbpScope id.
• dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
• value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
• active boolean
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

HrbpScopeRule

A single dimension rule within an HrbpScope (SN sn_talent_pulse_hrbp_scope_rule).

• id string
• scope_id string required — Parent HrbpScope id.
• dimension string required — Geo dimensions (location/region/country/city) all feed the hierarchical location scope.
• value string — The in-scope value for the dimension (null for all_access). Geo values may be a region (AMS), country (USA), or city (New York, NY).
• active boolean
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/snapshot_groups

List snapshot capture batches

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  SnapshotGroup

  Groups related metric snapshots captured in one run (SN sn_talent_pulse_snapshot_group).
  • id string
  • name string required
  • captured_at string
  • source string
  • note string
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/snapshot_groups

Create a snapshot capture batch

Parameters

Request body

application/json — required

SnapshotGroup

• id string
• name string required
• captured_at string
• source string
• note string
• createdAt string
• updatedAt string

Responses

201

Created

application/json

SnapshotGroup

Groups related metric snapshots captured in one run (SN sn_talent_pulse_snapshot_group).

• id string
• name string required
• captured_at string
• source string
• note string
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/snapshot_groups/{id}

Get a snapshot capture batch by id

Parameters

Responses

200

Found

application/json

SnapshotGroup

Groups related metric snapshots captured in one run (SN sn_talent_pulse_snapshot_group).

• id string
• name string required
• captured_at string
• source string
• note string
• createdAt string
• updatedAt string

404

Not found

DELETE /api/purple-suite/hrbp/snapshot_groups/{id}

Delete a snapshot capture batch

Parameters

Responses

200

Deleted

application/json

• success boolean

404

Not found

PATCH /api/purple-suite/hrbp/snapshot_groups/{id}

Edit a snapshot capture batch

Parameters

Request body

application/json

SnapshotGroup

• id string
• name string required
• captured_at string
• source string
• note string
• createdAt string
• updatedAt string

Responses

200

Updated

application/json

SnapshotGroup

Groups related metric snapshots captured in one run (SN sn_talent_pulse_snapshot_group).

• id string
• name string required
• captured_at string
• source string
• note string
• createdAt string
• updatedAt string

404

Not found

GET /api/purple-suite/hrbp/metric_sources

List metric data sources

Parameters

Responses

200

Paginated list

application/json

• data array

  array of:

  MetricSource

  A system a metric value can originate from (SN sn_talent_pulse_metric_source).
  • id string
  • key string required
  • name string required
  • description string
  • active boolean
  • createdAt string
  • updatedAt string
• nextCursor string — Cursor for the next page, or null on the last page. With $top/$skip this is the next $skip value; otherwise a keyset cursor.
• total integer — Total documents in the collection.
• @odata.count integer — Present only when $count=true: total matches after $filter/$search.
• @odata.truncated boolean — Present and true only when the collection exceeded the in-memory query cap and results may be incomplete.

400

Invalid OData query (e.g. malformed $filter)

POST /api/purple-suite/hrbp/metric_sources

Register a metric data source

Parameters

Request body

application/json — required

MetricSource

• id string
• key string required
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

Responses

201

Created

application/json

MetricSource

A system a metric value can originate from (SN sn_talent_pulse_metric_source).

• id string
• key string required
• name string required
• description string
• active boolean
• createdAt string
• updatedAt string

GET /api/purple-suite/hrbp/metric_sources/{id}

Get a metric data source by id