RESTful Get Legacy Labor Metrics

Dayforce RESTful Web Services Developer Guide

Version
R2025.2.1
RESTful Get Legacy Labor Metrics

This GET operation returns the details of a specific legacy labor metric. The operation uses the following URL:

https://www.dayforcehcm.com/api/CompanyName/V1/LegacyLaborMetric

Parameters

Consumers can retrieve the data associated with a legacy labor metric using the following parameters:

legacyLaborMetricType (string)

The type of legacy labor metric that will be retrieved, such as project client, project type, project phase, product group, and product module. This setting is required.

legacyLaborMetricXRefCode (string)

The unique identifier (external reference code) of the legacy labor metric that will be retrieved. The value provided must be an exact match, otherwise a bad request (400) error will be returned. This setting is required.

Response

The response is in JSON format as illustrated in the example below:

{
  "Data": {
    "Name": "string",
    "Description": "string",
    "LegacyLaborMetricType": "string",
    "LegacyLaborMetricXRefCode": "string"
  },
  "ProcessResults": [
    {
      "Code": "string",
      "Context": "string",
      "Level": "string",
      "Message": "string"
    }
  ]
}

Security

Retrieving an existing legacy labor metric requires role access to the following role features in the Features tab of System AdminRoles:

  • Org Setup
    • Labor Metrics
      • Legacy Labor Metrics
        • HTML Product Group
        • HTML Product Module
        • HTML Project Client
        • HTML Project Phase
        • HTML Project Type