Workday Help Article v1 — full pinned service

This reference is readable without JavaScript. Download the OpenAPI document.

Runtime

/api/purple-suite/{instanceId}/contracts/hris/workday

[
  {
    "method": "get",
    "path": "/helpArticle/v1/articleVersions",
    "operationId": "workdayHelpArticleGetArticleVersions"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalDecision",
    "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalDecision"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalDecision/:subresourceID",
    "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalDecisionBySubresourceID"
  },
  {
    "method": "patch",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalDecision/:subresourceID",
    "operationId": "workdayHelpArticlePatchArticleVersionsByIDApprovalDecisionBySubresourceID"
  },
  {
    "method": "delete",
    "path": "/helpArticle/v1/articleVersions/:ID/articleEffectiveDate/:subresourceID",
    "operationId": "workdayHelpArticleDeleteArticleVersionsByIDArticleEffectiveDateBySubresourceID"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleVersions/:ID",
    "operationId": "workdayHelpArticleGetArticleVersionsByID"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalRequest/:subresourceID",
    "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalRequestBySubresourceID"
  },
  {
    "method": "patch",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalRequest/:subresourceID",
    "operationId": "workdayHelpArticlePatchArticleVersionsByIDApprovalRequestBySubresourceID"
  },
  {
    "method": "post",
    "path": "/helpArticle/v1/articleVersions/:ID/approvalRequest",
    "operationId": "workdayHelpArticlePostArticleVersionsByIDApprovalRequest"
  },
  {
    "method": "post",
    "path": "/helpArticle/v1/articleVersions/:ID/articleEffectiveDate",
    "operationId": "workdayHelpArticlePostArticleVersionsByIDArticleEffectiveDate"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleStatuses",
    "operationId": "workdayHelpArticleGetArticleStatuses"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/articleStatuses/:ID",
    "operationId": "workdayHelpArticleGetArticleStatusesByID"
  },
  {
    "method": "get",
    "path": "/helpArticle/v1/values/common/audiences/",
    "operationId": "workdayHelpArticleGetValuesCommonAudiences"
  }
]

Credentials

OAuth 2.0 bearer token: Authorization: Bearer <TOKEN>
The painted runtime validates a PurpleSuite instance key in the Workday bearer-token transport.
Credential model: instance-key

Coverage and limitations

{
  "documentScope": "full",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 13
  },
  "notes": [
    "All 13 operations in the pinned 2026-07-27 Workday Help Article v1 artifact are mounted: 0 captured handlers and 13 per-instance repository-backed operations.",
    "Modeled reads return stored resources, relationship-scoped collections, or native 404s; modeled writes provide read-after-write lifecycle behavior and never return request-seeded schema witnesses.",
    "Full means the complete pinned service artifact, not the whole Workday platform.",
    "Explicitly excluded: Workday Web Services (SOAP/WWS); Workday Graph API; Workday Query Language (WQL), a separate Platform API family; Reports-as-a-Service (RaaS) and tenant custom reports; Finance, Payroll, Student, and non-HR Platform REST services; Experimental alpha, beta, and labs services; Tenant-configured actions absent from the pinned public artifacts."
  ]
}

The helpArticle service enables applications to access and return article data.

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/hris/workday",
    "description": "PurpleSuite Workday-painted instance boundary",
    "variables": {
      "instanceId": {
        "default": "INSTANCE_ID",
        "description": "PurpleSuite instance identifier"
      }
    }
  }
]

Authentication schemes

{
  "OAuth2": {
    "type": "oauth2",
    "flows": {
      "implicit": {
        "authorizationUrl": "https://<tenantAuthorizationHostname>",
        "scopes": {}
      }
    }
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

GET /helpArticle/v1/articleVersions
GET /helpArticle/v1/articleVersions/{ID}/approvalDecision
GET /helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}
PATCH /helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}
DELETE /helpArticle/v1/articleVersions/{ID}/articleEffectiveDate/{subresourceID}
GET /helpArticle/v1/articleVersions/{ID}
GET /helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}
PATCH /helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}
POST /helpArticle/v1/articleVersions/{ID}/approvalRequest
POST /helpArticle/v1/articleVersions/{ID}/articleEffectiveDate
GET /helpArticle/v1/articleStatuses
GET /helpArticle/v1/articleStatuses/{ID}
GET /helpArticle/v1/values/common/audiences/

GET /helpArticle/v1/articleVersions

Retrieves a list of article versions and the plain text content within each article version.

Retrieves a list of article versions and the plain text content within each article version. Also includes: audience, category, created date, created by, last updated date, last updated by, language, location, status, tags, title, view link, and the parent article Secured By Domain: Help Article REST API, Manage: Article Sharing Versions, Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Retrieves a list of article versions and the plain text content within each article version.",
  "description": "Retrieves a list of article versions and the plain text content within each article version. Also includes: audience, category, created date, created by, last updated date, last updated by, language, location, status, tags, title, view link, and the parent article\n\n<b>Secured By Domain:</b> Help Article REST API, Manage: Article Sharing Versions, Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "audience",
      "in": "query",
      "description": "The audience of the article version.",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "status",
      "in": "query",
      "description": "The status of the article version.",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/articleVersionDetails_0d75a5e37a41100016a8f2506df70000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "0d75a5e37a41100016a8f1b6e01c0000",
  "x-workday-secured-by-domains": [
    "Help Article REST API",
    "Manage: Article Sharing Versions",
    "Manage: Help Articles"
  ]
}

GET /helpArticle/v1/articleVersions/{ID}/approvalDecision

Returns all approval decisions for the current user.

Returns all approval decisions associated with the article data for the current user. Secured By Domain: Manage: Article Sharing Versions Scope: Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Returns all approval decisions for the current user.",
  "description": "Returns all approval decisions associated with the article data for the current user.\n\n<b>Secured By Domain:</b> Manage: Article Sharing Versions\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/decisionView_6aa8f8927521100024077994fa110000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "6aa8f89275211000197b631df44f0000",
  "x-workday-secured-by-domains": [
    "Manage: Article Sharing Versions"
  ]
}

GET /helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}

Returns all approval decisions for the current user.

Returns all approval decisions associated with the article data for the current user. Secured By Domain: Manage: Article Sharing Versions Scope: Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Returns all approval decisions for the current user.",
  "description": "Returns all approval decisions associated with the article data for the current user.\n\n<b>Secured By Domain:</b> Manage: Article Sharing Versions\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/decisionView_6aa8f8927521100024077994fa110000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "6aa8f89275211000197b631df44f0000",
  "x-workday-secured-by-domains": [
    "Manage: Article Sharing Versions"
  ]
}

PATCH /helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}

Updates the decision type and decision comment.

Updates the decision type and decision comment for the article approval decision. Secured By Domain: Manage: Article Sharing Versions Scope: Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Updates the decision type and decision comment.",
  "description": "Updates the decision type and decision comment for the article approval decision.\n\n<b>Secured By Domain:</b> Manage: Article Sharing Versions\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/approvalDecisionUpdate_e77d86a20fbf10000ac9eeccfe9a0000"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Updating resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/approvalDecisionUpdate_e77d86a20fbf10000ac9eeccfe9a0000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2889 | You must have approval permissions to make a decision |\n| Critical | A2890 | You can only update your own approval decision |\n| Critical | A2891 | You must provide a comment to deny the request |\n| Critical | A2892 | Specify a valid decision type |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "e77d86a20fbf10000ad8a527ce990000",
  "x-workday-secured-by-domains": [
    "Manage: Article Sharing Versions"
  ]
}

DELETE /helpArticle/v1/articleVersions/{ID}/articleEffectiveDate/{subresourceID}

Deletes the effective dates for the article version.

Deletes the publish and expiration dates for an article version. This action removes any scheduled publishing or archiving for the article. Secured By Domain: Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Deletes the effective dates for the article version.",
  "description": "Deletes the publish and expiration dates for an article version. This action removes any scheduled publishing or archiving for the article.\n\n<b>Secured By Domain:</b> Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Deleting resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2879 | You can't delete the expiration date for an archived article. |\n| Critical | A2881 | You can't delete the publish date for a published or archived article. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d51d3035ab9910000b40f628be170002",
  "x-workday-secured-by-domains": [
    "Manage: Help Articles"
  ]
}

GET /helpArticle/v1/articleVersions/{ID}

Retrieve an article version and the plain text content for the article version.

Retrieve an article version and the plain text content for the article version. Also includes: audience, category, created date, created by, last updated date, last updated by, language, location, status, tags, title, view link, and the parent article Secured By Domain: Help Article REST API, Manage: Article Sharing Versions, Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Retrieve an article version and the plain text content for the article version.",
  "description": "Retrieve an article version and the plain text content for the article version. Also includes: audience, category, created date, created by, last updated date, last updated by, language, location, status, tags, title, view link, and the parent article\n\n<b>Secured By Domain:</b> Help Article REST API, Manage: Article Sharing Versions, Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/articleVersionDetails_0d75a5e37a41100016a8f2506df70000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "0d75a5e37a41100016a8f1b6e01c0000",
  "x-workday-secured-by-domains": [
    "Help Article REST API",
    "Manage: Article Sharing Versions",
    "Manage: Help Articles"
  ]
}

GET /helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}

Returns an instance of Approval Request from /kbApprovalRequest resource.

Returns an instance of Approval Request from /articleVersions//approvalRequest sub-collection resource. Secured By Domain: Manage: Article Sharing Versions, Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Returns an instance of Approval Request from /kbApprovalRequest resource.",
  "description": "Returns an instance of Approval Request from /articleVersions//approvalRequest sub-collection resource.\n\n<b>Secured By Domain:</b> Manage: Article Sharing Versions, Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/approvalRequestView_1983281de776100025059194c2760000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "1983281de77610001fcfbc979c670002",
  "x-workday-secured-by-domains": [
    "Manage: Article Sharing Versions",
    "Manage: Help Articles"
  ]
}

PATCH /helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}

Updates an instance of the /approvalRequest resource.

Updates an instance and related instances of the /articleVersions//approvalRequest sub-collection resource with the provided properties. Secured By Domain: Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Updates an instance of the /approvalRequest resource.",
  "description": "Updates an instance and related instances of the /articleVersions//approvalRequest sub-collection resource with the provided properties.\n\n<b>Secured By Domain:</b> Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/approvalRequestUpdate_1983281de776100025147dcda6320000"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Updating resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/approvalRequestUpdate_1983281de776100025147dcda6320000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A3077 | Approval request type cannot be changed. |\n| Critical | A3078 | Approval request is outdated. |\n| Critical | A3079 | Approval request has been cancelled. |\n| Critical | A3080 | Only approvals with decisions can be outdated. |\n| Critical | A3081 | An approval request with decisions cannot be cancelled. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "1983281de77610001fcfbc979c670003",
  "x-workday-secured-by-domains": [
    "Manage: Help Articles"
  ]
}

POST /helpArticle/v1/articleVersions/{ID}/approvalRequest

Creates an instance of Approval Request, Approval Decision(s) and Share Assignment.

Creates an instance of Article Approval Request, as well as the related Article Approval Decision(s) and Article Share Assignment for the /articleVersions//approvalRequest sub-collection resource with the provided properties. Secured By Domain: Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "summary": "Creates an instance of Approval Request, Approval Decision(s) and Share Assignment.",
  "description": "Creates an instance of Article Approval Request, as well as the related Article Approval Decision(s) and Article Share Assignment for the /articleVersions//approvalRequest sub-collection resource with the provided properties.\n\n<b>Secured By Domain:</b> Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/approvalRequestCreate_1983281de7761000221fce74dbf50000"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/approvalRequestCreate_1983281de7761000221fce74dbf50000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2790 | At least one approver is required. |\n| Critical | A3060 | A pending approval request exists for this article. |\n| Critical | A3061 | Specify a language to request approval. |\n| Critical | A3062 | Specify a category to request approval. |\n| Critical | A3063 | The article is pending publication. |\n| Critical | A3064 | Specify at least 1 audience to request approval. |\n| Critical | A3065 | Enter content in the text editor to request approval. |\n| Critical | A3265 | Specify an approver other than yourself. |\n| Critical | A3266 | Specify a valid approval type. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "1983281de77610001fcfbc979c670000",
  "x-workday-secured-by-domains": [
    "Manage: Help Articles"
  ]
}

POST /helpArticle/v1/articleVersions/{ID}/articleEffectiveDate

Secured By Domain: Manage: Help Articles Scope: Help, People Experience

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleVersions"
  ],
  "description": "\n\n<b>Secured By Domain:</b> Manage: Help Articles\n\n<b>Scope:</b> Help, People Experience",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/articleDataEffectiveDatesEdit_d51d3035ab9910000fbc2506aba00000"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/articleDataEffectiveDatesEdit_d51d3035ab9910000fbc2506aba00000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2878 | Specify a publication date before the expiration date. |\n| Critical | A2880 | Specify an expiration date after the current date. |\n| Critical | A2882 | The article already has defined dates. Update the existing dates instead of adding new ones. |\n| Critical | A3032 | Specify an article ID without pending approvals. You can't set publication or expiration dates for an article with pending approvals. |\n| Critical | A3033 | Specify a value for Category before setting publication or expiration dates. |\n| Critical | A3034 | Specify a value for Language before setting publication or expiration dates. |\n| Critical | A3035 | Specify an article ID for a draft article. The article must be a draft to set publication or expiration dates. |\n| Critical | A3036 | Specify a value for Audience before setting publication or expiration dates. |\n| Critical | A3037 | Specify content for the article before setting publication or expiration dates. |\n| Critical | A3163 | You can't add publication dates or expiration dates to an article was already approved or rejected. |\n| Critical | A3164 | You can't add publication dates or expiration dates to an article that was already rejected. |\n| Critical | A3199 | Specify a publication date. |\n| Critical | A3282 | You can't add publication dates or expiration dates to an article with an outdated approval. |",
      "content": {}
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-confidence-level": "Production",
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d51d3035ab9910000b40f628be170000",
  "x-workday-secured-by-domains": [
    "Manage: Help Articles"
  ]
}

GET /helpArticle/v1/articleStatuses

Retrieves a list of article version statuses for all articles.

Retrieves a list of article version statuses for all articles. An article version can have a status of Published, Draft, or Archived. Secured By Domain: Help Article REST API Scope: Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleStatuses"
  ],
  "summary": "Retrieves a list of article version statuses for all articles.",
  "description": "Retrieves a list of article version statuses for all articles. An article version can have a status of Published, Draft, or Archived.\n\n<b>Secured By Domain:</b> Help Article REST API\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/versionStatusDetails_8ed616626bb410000a7f55605fc20000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "8ed616626bb410000a57ba0538600000",
  "x-workday-secured-by-domains": [
    "Help Article REST API"
  ]
}

GET /helpArticle/v1/articleStatuses/{ID}

Retrieve an article version status for an article.

Retrieve an article version status for an article. An article version can have a status of Published, Draft, or Archived. Secured By Domain: Help Article REST API Scope: Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "articleStatuses"
  ],
  "summary": "Retrieve an article version status for an article.",
  "description": "Retrieve an article version status for an article. An article version can have a status of Published, Draft, or Archived.\n\n<b>Secured By Domain:</b> Help Article REST API\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/versionStatusDetails_8ed616626bb410000a7f55605fc20000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "8ed616626bb410000a57ba0538600000",
  "x-workday-secured-by-domains": [
    "Help Article REST API"
  ]
}

GET /helpArticle/v1/values/common/audiences/

Retrieves instances that can be used as values for other endpoint parameters in this service.

Authentication

[
  {
    "OAuth2": []
  }
]

Path-level parameters and metadata

{
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default and maximum is 1000.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "search",
      "in": "query",
      "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
      "schema": {
        "type": "string"
      }
    }
  ]
}

Request, responses and operation details

{
  "tags": [
    "Prompt Values"
  ],
  "description": "Retrieves instances that can be used as values for other endpoint parameters in this service.",
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/MULTIPLE_INSTANCE_MODEL_REFERENCE"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-protected-usage-enabled": false,
  "x-workday-internal-try-enabled": "false"
}

Schemas and reusable components

schemas

INSTANCE_MODEL_REFERENCE

{
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance",
      "readOnly": true
    },
    "href": {
      "type": "string",
      "description": "A link to the instance",
      "readOnly": true
    }
  }
}

ERROR_MODEL_REFERENCE

{
  "required": [
    "error"
  ],
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "code": {
      "type": "string",
      "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "severity": {
      "type": "string",
      "description": "Severity of the validation (e.g. Critical, Warning)."
    },
    "internalMessage": {
      "type": "string",
      "description": "Internal message providing additional context for the validation (e.g. representation content validation details)."
    }
  }
}

VALIDATION_ERROR_MODEL_REFERENCE

{
  "allOf": [
    {
      "required": [
        "error"
      ],
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "description": "A description of the error"
        },
        "errors": {
          "type": "array",
          "description": "An array of validation errors",
          "items": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  ]
}

FACETS_MODEL_REFERENCE

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "descriptor": {
        "type": "string",
        "description": "A description of the facet"
      },
      "facetParameter": {
        "type": "string",
        "description": "The alias used to select the facet"
      },
      "values": {
        "type": "array",
        "description": "the facet values",
        "items": {
          "required": [
            "id"
          ],
          "type": "object",
          "properties": {
            "count": {
              "type": "integer",
              "description": "The number of instances returned by this facet",
              "format": "int32"
            },
            "id": {
              "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
              "type": "string",
              "description": "Workday Id or Reference Id of the instance."
            },
            "descriptor": {
              "type": "string",
              "description": "A description of the facet"
            },
            "href": {
              "type": "string",
              "description": "A link to the instance",
              "readOnly": true
            }
          }
        }
      }
    },
    "description": "This object represents the possible facets for this resource",
    "readOnly": true
  }
}

MULTIPLE_INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
      }
    }
  }
}

location_6ee6774fa0f0100012c7164657f20000

{
  "description": "The location of the article version.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

createdByWorker_5c74ffa1092310000ae8c69cc6a50000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/articleVersionWorker_3756770653d3100007c01379ac670000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

language_6ee6774fa0f0100012a7c04fd8450000

{
  "description": "The language of the article version.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

tags_6ee6774fa0f01000139edb3326760000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/articleVersionTag_6ee6774fa0f0100014d2f5169f340000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Knowledge Base Article Tag"
        }
      }
    }
  ]
}

parentArticle_e557f584839f10000f2fdbaf70bc0000

{
  "description": "The article that the version relates to.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

audience_6ee6774fa0f01000123046a473530000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/articleVersionAudience_8ac3f16c1fff10000c53e90920940000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Article Audience"
        }
      }
    }
  ],
  "x-workday-populated-by": {
    "path": "/values/common/audiences",
    "field": "id"
  }
}

lastUpdatedByWorker_3756770653d3100007f11cd104f50000

{
  "allOf": [
    {
      "$ref": "#/components/schemas/articleVersionWorker_3756770653d3100007c01379ac670000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for \\~Worker\\~"
        }
      }
    }
  ]
}

status_6ee6774fa0f0100013127030a8300000

{
  "description": "The status of the article version.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

category_6ee6774fa0f010001256232e36660000

{
  "description": "The category of the article version.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

articleVersionDetails_0d75a5e37a41100016a8f2506df70000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "location": {
          "$ref": "#/components/schemas/location_6ee6774fa0f0100012c7164657f20000"
        },
        "createdByWorker": {
          "type": "array",
          "description": "The worker who created the article version.",
          "items": {
            "$ref": "#/components/schemas/createdByWorker_5c74ffa1092310000ae8c69cc6a50000"
          },
          "x-workday-type": "Multi-instance"
        },
        "latestPublishedVersionViewURL": {
          "type": "string",
          "description": "Returns a URL that links to the latest article version in Workday. This field only returns a value if the article is published.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "language": {
          "$ref": "#/components/schemas/language_6ee6774fa0f0100012a7c04fd8450000"
        },
        "title": {
          "type": "string",
          "description": "The title of the article version.",
          "example": "Help Article",
          "x-workday-type": "Text"
        },
        "tags": {
          "type": "array",
          "description": "The tags added to the article version.",
          "items": {
            "$ref": "#/components/schemas/tags_6ee6774fa0f01000139edb3326760000"
          },
          "x-workday-type": "Multi-instance"
        },
        "version": {
          "type": "integer",
          "description": "The version number of the article.",
          "format": "int32",
          "example": 1,
          "x-workday-type": "Numeric"
        },
        "parentArticle": {
          "$ref": "#/components/schemas/parentArticle_e557f584839f10000f2fdbaf70bc0000"
        },
        "createdDate": {
          "type": "string",
          "description": "The created date of the article version.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "lastUpdatedDate": {
          "type": "string",
          "description": "The data that the article was last updated.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "viewLink": {
          "type": "string",
          "description": "Returns a URL that links to the article version in Workday. This field only returns a value if the article is published.",
          "example": "https://workdaysuv/tenantName/d/inst/articleWID/rel-task/taskID.htmld",
          "x-workday-type": "Text"
        },
        "audience": {
          "type": "array",
          "description": "The audiences that can view the article version.",
          "items": {
            "$ref": "#/components/schemas/audience_6ee6774fa0f01000123046a473530000"
          },
          "x-workday-type": "Multi-instance"
        },
        "lastUpdatedByWorker": {
          "type": "array",
          "description": "The worker who last updated the article version.",
          "items": {
            "$ref": "#/components/schemas/lastUpdatedByWorker_3756770653d3100007f11cd104f50000"
          },
          "x-workday-type": "Multi-instance"
        },
        "status": {
          "$ref": "#/components/schemas/status_6ee6774fa0f0100013127030a8300000"
        },
        "category": {
          "$ref": "#/components/schemas/category_6ee6774fa0f010001256232e36660000"
        },
        "content": {
          "type": "string",
          "description": "The content of the article version displayed in plain text.",
          "example": "Here's an articles content",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

type_e77d86a20fbf10000ac9ef66ad7e0001

{
  "description": "The decision type for the Article Approval Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approvalDecisionUpdate_e77d86a20fbf10000ac9eeccfe9a0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "description": "Time the Article Approval Decision was made.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "type": {
          "$ref": "#/components/schemas/type_e77d86a20fbf10000ac9ef66ad7e0001"
        },
        "comment": {
          "type": "string",
          "description": "Comment associated with the Article Approval Decision.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

approver_9ccf03145f6b10000c467501716d0000

{
  "description": "The share assignment associated with the Approval Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/approverShare_1983281de7761000221b7f9114ec0000"
    },
    {
      "type": "object"
    }
  ]
}

type_9ccf03145f6b10000c46759b1bf20002

{
  "description": "Decision type for the Article Approval Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approvalRequest_6aa8f8927521100026922454504b0000

{
  "description": "The Article Approval Request associated with the Approval Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/decisionApprovalRequestView_fc6a9bc0eb4310002d20d6e52c060000"
    },
    {
      "type": "object"
    }
  ]
}

decisionView_6aa8f8927521100024077994fa110000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "timestamp": {
          "type": "string",
          "description": "Timestamp the decision was made.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "comment": {
          "type": "string",
          "description": "Comment associated with the decision.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "approver": {
          "$ref": "#/components/schemas/approver_9ccf03145f6b10000c467501716d0000"
        },
        "type": {
          "$ref": "#/components/schemas/type_9ccf03145f6b10000c46759b1bf20002"
        },
        "approvalRequest": {
          "$ref": "#/components/schemas/approvalRequest_6aa8f8927521100026922454504b0000"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

type_1983281de776100025147dcda6320001

{
  "description": "Type of the Article Approval.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approvalRequestUpdate_1983281de776100025147dcda6320000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/type_1983281de776100025147dcda6320001"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

type_1983281de776100025059194c2760003

{
  "description": "Type of the Article Approval.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

decisions_1983281de776100025059194c2760002

{
  "allOf": [
    {
      "$ref": "#/components/schemas/approvalDecisionView_1983281de77610002503fa8ddba80000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Article Approval Decision"
        }
      }
    }
  ]
}

approvalRequestView_1983281de776100025059194c2760000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "The status of the Article Approval request.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "created": {
          "type": "string",
          "description": "Time the Article Approval was created.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "type": {
          "$ref": "#/components/schemas/type_1983281de776100025059194c2760003"
        },
        "decisions": {
          "type": "array",
          "description": "Decisions for the Article Approval.",
          "items": {
            "$ref": "#/components/schemas/decisions_1983281de776100025059194c2760002"
          },
          "x-workday-type": "Multi-instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

decisions_1983281de7761000221fce74dbf50001

{
  "allOf": [
    {
      "$ref": "#/components/schemas/approvalDecisionCreate_1983281de7761000221d5aeb514c0000"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Article Approval Decision"
        }
      }
    }
  ]
}

type_1983281de7761000221fcf0e7e2e0000

{
  "description": "Type of the Article Approval.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approvalRequestCreate_1983281de7761000221fce74dbf50000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "lastUpdated": {
          "type": "string",
          "description": "Time the Article Approval was last updated.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "decisions": {
          "type": "array",
          "description": "Decisions for the Article Approval.",
          "items": {
            "$ref": "#/components/schemas/decisions_1983281de7761000221fce74dbf50001"
          },
          "x-workday-type": "Multi-instance"
        },
        "created": {
          "type": "string",
          "description": "Time the Article Approval was created.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "type": {
          "$ref": "#/components/schemas/type_1983281de7761000221fcf0e7e2e0000"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

articleDataEffectiveDatesEdit_d51d3035ab9910000fbc2506aba00000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "publishDate": {
          "type": "string",
          "description": "The date the article version becomes available to users.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "expirationDate": {
          "type": "string",
          "description": "The date Workday archives the article version.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

versionStatusDetails_8ed616626bb410000a7f55605fc20000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

approver_1983281de77610002503fb276df60000

{
  "description": "Share Assignment for the user making the Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/approverShare_1983281de7761000221b7f9114ec0000"
    },
    {
      "type": "object"
    }
  ]
}

type_1983281de77610002503fb276df60003

{
  "description": "Decision type for the Article Approval Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approvalDecisionView_1983281de77610002503fa8ddba80000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "approver": {
          "$ref": "#/components/schemas/approver_1983281de77610002503fb276df60000"
        },
        "comment": {
          "type": "string",
          "description": "Comment associated with the decision.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "timestamp": {
          "type": "string",
          "description": "Timestamp the decision was made",
          "format": "date",
          "x-workday-type": "Date"
        },
        "type": {
          "$ref": "#/components/schemas/type_1983281de77610002503fb276df60003"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

approver_1983281de7761000221d5aeb514c0001

{
  "description": "Share Assignment for the user making the Decision.",
  "allOf": [
    {
      "$ref": "#/components/schemas/approverShare_1983281de7761000221b7f9114ec0000"
    },
    {
      "type": "object"
    }
  ]
}

approvalDecisionCreate_1983281de7761000221d5aeb514c0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "approver": {
          "$ref": "#/components/schemas/approver_1983281de7761000221d5aeb514c0001"
        },
        "id": {
          "type": "string",
          "description": "The id for Article Approval Decision"
        }
      }
    }
  ]
}

articleVersionAudience_8ac3f16c1fff10000c53e90920940000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

decisionApprovalRequestView_fc6a9bc0eb4310002d20d6e52c060000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "created": {
          "type": "string",
          "description": "The time the approval request was created.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "status": {
          "type": "string",
          "description": "The status of the approval request.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

worker_1983281de7761000221b7f9114ec0001

{
  "description": "The Worker for the Approver's Share Assignment.",
  "allOf": [
    {
      "$ref": "#/components/schemas/approvalWorkerView_1983281de776100022131fc9a09b0000"
    },
    {
      "type": "object"
    }
  ]
}

requestedBy_5a32340a836e1000120a579ae88a0000

{
  "description": "The Worker that the Share Assignment was shared by.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

approverShare_1983281de7761000221b7f9114ec0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "worker": {
          "$ref": "#/components/schemas/worker_1983281de7761000221b7f9114ec0001"
        },
        "message": {
          "type": "string",
          "description": "The message to the Approver.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "requestedBy": {
          "$ref": "#/components/schemas/requestedBy_5a32340a836e1000120a579ae88a0000"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

articleVersionWorker_3756770653d3100007c01379ac670000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

articleVersionTag_6ee6774fa0f0100014d2f5169f340000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

approvalWorkerView_1983281de776100022131fc9a09b0000

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "profileUrl": {
          "type": "string",
          "description": "Profile URL of the worker",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

securitySchemes

OAuth2

{
  "type": "oauth2",
  "flows": {
    "implicit": {
      "authorizationUrl": "https://<tenantAuthorizationHostname>",
      "scopes": {}
    }
  }
}

Path metadata and references

{
  "/helpArticle/v1/values/common/audiences/": {
    "parameters": [
      {
        "name": "limit",
        "in": "query",
        "description": "The maximum number of objects in a single response. The default and maximum is 1000.",
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      {
        "name": "offset",
        "in": "query",
        "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      {
        "name": "search",
        "in": "query",
        "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.",
        "schema": {
          "type": "string"
        }
      }
    ]
  }
}

Document metadata and extensions

{
  "openapi": "3.0.1",
  "info": {
    "title": "helpArticle",
    "description": "The helpArticle service enables applications to access and return article data.",
    "version": "v1",
    "x-workday-internal-source": "xo",
    "x-workday-internal-routing": "Public",
    "x-workday-internal-protected-usage-enabled": false,
    "x-workday-internal-service-container-id": "0d75a5e37a411000167d21b9239f0001"
  },
  "tags": [
    {
      "name": "articleStatuses",
      "description": "Retrieves a list of statuses for article versions."
    },
    {
      "name": "articleVersions",
      "description": "Retrieves a list of article versions and content.\n\nThe resource will only return all instances when the user has access to the Help Article API domain. Specific instance retrieval is constrained by the following criteria:\n1. Service accounts and users with access to the HELP Article API domain have full access to retrieve any instance\n2. Users with access to the Manage: Help Articles domain will have access to retrieve specific instances they have access to edit.\n3. Users with access to the Manage: Article Version Sharing have access to specific instances they have shared access to. \n4. Users with access to the View: Help Articles domain will have access to specific instances they have access to based on the condition rules associated with the article version.",
      "x-workday-confidence-level": "Production"
    },
    {
      "name": "Prompt Values",
      "description": "Retrieves instances that can be used as values for other endpoint parameters in this service."
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ],
  "x-purple-suite-contract": "full-service-repository-modeled-runtime",
  "x-purple-suite-upstream-servers": [
    {
      "url": "https://<tenantHostname>/helpArticle/v1"
    }
  ],
  "x-purple-suite-runtime-fidelity": {
    "capturedOperationIds": [],
    "modeledOperationIds": [
      "workdayHelpArticleGetArticleVersions",
      "workdayHelpArticleGetArticleVersionsByIDApprovalDecision",
      "workdayHelpArticleGetArticleVersionsByIDApprovalDecisionBySubresourceID",
      "workdayHelpArticlePatchArticleVersionsByIDApprovalDecisionBySubresourceID",
      "workdayHelpArticleDeleteArticleVersionsByIDArticleEffectiveDateBySubresourceID",
      "workdayHelpArticleGetArticleVersionsByID",
      "workdayHelpArticleGetArticleVersionsByIDApprovalRequestBySubresourceID",
      "workdayHelpArticlePatchArticleVersionsByIDApprovalRequestBySubresourceID",
      "workdayHelpArticlePostArticleVersionsByIDApprovalRequest",
      "workdayHelpArticlePostArticleVersionsByIDArticleEffectiveDate",
      "workdayHelpArticleGetArticleStatuses",
      "workdayHelpArticleGetArticleStatusesByID",
      "workdayHelpArticleGetValuesCommonAudiences"
    ],
    "operations": [
      {
        "operationId": "workdayHelpArticleGetArticleVersions",
        "method": "get",
        "path": "/helpArticle/v1/articleVersions",
        "upstreamPath": "/articleVersions",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0d75a5e37a41100016a8f1b6e01c0000"
      },
      {
        "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalDecision",
        "method": "get",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalDecision",
        "upstreamPath": "/articleVersions/{ID}/approvalDecision",
        "fidelity": "modeled",
        "xWorkdayOperationId": "6aa8f89275211000197b631df44f0000"
      },
      {
        "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalDecisionBySubresourceID",
        "method": "get",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}",
        "upstreamPath": "/articleVersions/{ID}/approvalDecision/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "6aa8f89275211000197b631df44f0000"
      },
      {
        "operationId": "workdayHelpArticlePatchArticleVersionsByIDApprovalDecisionBySubresourceID",
        "method": "patch",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalDecision/{subresourceID}",
        "upstreamPath": "/articleVersions/{ID}/approvalDecision/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "e77d86a20fbf10000ad8a527ce990000"
      },
      {
        "operationId": "workdayHelpArticleDeleteArticleVersionsByIDArticleEffectiveDateBySubresourceID",
        "method": "delete",
        "path": "/helpArticle/v1/articleVersions/{ID}/articleEffectiveDate/{subresourceID}",
        "upstreamPath": "/articleVersions/{ID}/articleEffectiveDate/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d51d3035ab9910000b40f628be170002"
      },
      {
        "operationId": "workdayHelpArticleGetArticleVersionsByID",
        "method": "get",
        "path": "/helpArticle/v1/articleVersions/{ID}",
        "upstreamPath": "/articleVersions/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0d75a5e37a41100016a8f1b6e01c0000"
      },
      {
        "operationId": "workdayHelpArticleGetArticleVersionsByIDApprovalRequestBySubresourceID",
        "method": "get",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}",
        "upstreamPath": "/articleVersions/{ID}/approvalRequest/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "1983281de77610001fcfbc979c670002"
      },
      {
        "operationId": "workdayHelpArticlePatchArticleVersionsByIDApprovalRequestBySubresourceID",
        "method": "patch",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalRequest/{subresourceID}",
        "upstreamPath": "/articleVersions/{ID}/approvalRequest/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "1983281de77610001fcfbc979c670003"
      },
      {
        "operationId": "workdayHelpArticlePostArticleVersionsByIDApprovalRequest",
        "method": "post",
        "path": "/helpArticle/v1/articleVersions/{ID}/approvalRequest",
        "upstreamPath": "/articleVersions/{ID}/approvalRequest",
        "fidelity": "modeled",
        "xWorkdayOperationId": "1983281de77610001fcfbc979c670000"
      },
      {
        "operationId": "workdayHelpArticlePostArticleVersionsByIDArticleEffectiveDate",
        "method": "post",
        "path": "/helpArticle/v1/articleVersions/{ID}/articleEffectiveDate",
        "upstreamPath": "/articleVersions/{ID}/articleEffectiveDate",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d51d3035ab9910000b40f628be170000"
      },
      {
        "operationId": "workdayHelpArticleGetArticleStatuses",
        "method": "get",
        "path": "/helpArticle/v1/articleStatuses",
        "upstreamPath": "/articleStatuses",
        "fidelity": "modeled",
        "xWorkdayOperationId": "8ed616626bb410000a57ba0538600000"
      },
      {
        "operationId": "workdayHelpArticleGetArticleStatusesByID",
        "method": "get",
        "path": "/helpArticle/v1/articleStatuses/{ID}",
        "upstreamPath": "/articleStatuses/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "8ed616626bb410000a57ba0538600000"
      },
      {
        "operationId": "workdayHelpArticleGetValuesCommonAudiences",
        "method": "get",
        "path": "/helpArticle/v1/values/common/audiences/",
        "upstreamPath": "/values/common/audiences/",
        "fidelity": "modeled"
      }
    ]
  },
  "x-purple-suite-exclusions": [
    "Workday Web Services (SOAP/WWS)",
    "Workday Graph API",
    "Workday Query Language (WQL), a separate Platform API family",
    "Reports-as-a-Service (RaaS) and tenant custom reports",
    "Finance, Payroll, Student, and non-HR Platform REST services",
    "Experimental alpha, beta, and labs services",
    "Tenant-configured actions absent from the pinned public artifacts"
  ]
}