Workday Help Case v4 — full pinned service

GET /helpCase/v4/serviceCategories

Retrieves all parent service categories.

Retrieves all parent service categories. Details include: name, description, case types, and child service categories. Only returns case types within each service category that the processing worker has access to. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "serviceCategories"
  ],
  "summary": "Retrieves all parent service categories.",
  "description": "Retrieves all parent service categories. Details include: name, description, case types, and child service categories. Only returns case types within each service category that the processing worker has access to.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\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"
      }
    },
    {
      "name": "q",
      "in": "query",
      "description": "The name to search for. Use this parameter to return only: service categories with a name that matches or is similar to this string; service categories that have child categories with names that match or are similar to this string; and case types with names or descriptions that are similar to this string. The default value is empty.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "worker",
      "in": "query",
      "description": "The ID of an alternate worker to use instead of the processing worker when determining access to case types. The default value is empty.",
      "schema": {
        "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/serviceCategory_88561109bc0610000dcc0edead59afc0"
                }
              }
            }
          }
        }
      }
    },
    "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": "88561109bc0610000cd8665c8eaf9361",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/serviceCategories/{ID}

Retrieves a service category with the specified ID.

Retrieves a service category with the specified ID. Details include: name, description, case types, and child categories. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "serviceCategories"
  ],
  "summary": "Retrieves a service category with the specified ID.",
  "description": "Retrieves a service category with the specified ID.\nDetails include: name, description, case types, and child categories.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\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/serviceCategory_88561109bc0610000dcc0edead59afc0"
          }
        }
      }
    },
    "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": "88561109bc0610000cd8665c8eaf9361",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/cases

Retrieves a list of cases that the user is secured to view.

Retrieves a list of case details that the user is secured to view. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam. <b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a list of cases that the user is secured to view.",
  "description": "Retrieves a list of case details that the user is secured to view. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam.\n\n<b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "desc",
      "in": "query",
      "description": "If true, sorts results in descending order.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "flag",
      "in": "query",
      "description": "Retrieves cases with the assigned flag(s).",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "label",
      "in": "query",
      "description": "Retrieves cases with the assigned label(s).",
      "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": "myCases",
      "in": "query",
      "description": "Retrieves cases owned by the processing user.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "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": "openCases",
      "in": "query",
      "description": "Retrieves open cases and cases that were resolved or canceled less than 7 days ago.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "sort",
      "in": "query",
      "description": "The field to sort results by. The default is creationDate. Note: Currently supports creationDate only.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "status",
      "in": "query",
      "description": "Retrieves cases with the specified status(es).",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "substatus",
      "in": "query",
      "description": "Retrieves cases with the specified substatus(es).",
      "style": "form",
      "explode": true,
      "schema": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    {
      "name": "team",
      "in": "query",
      "description": "Retrieves cases with the specified service team(s).",
      "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/caseDetails_c6fb55da58da1000144f81f7eb854c37"
                }
              }
            }
          }
        }
      }
    },
    "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": "c6fb55da58da10000d42ff1f76a149c0",
  "x-workday-secured-by-domains": [
    "Help Case Data",
    "Self Service: Help Case Management"
  ]
}

POST /helpCase/v4/cases

Creates a case.

Creates a single case instance with the specified data. In the request body, specify at least these required fields: caseType {id}, caseTitle {text}. You can add attachments by first calling the attachment API to get an attachments ID, and then including this ID in the Create Case request. You can also embed attachment details in the Create Case request. You can only include attachment types that are configured on the tenant. You can use GET /helpCase/configuration to determine which attachment types are supported. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Creates a case.",
  "description": "Creates a single case instance with the specified data.\n\nIn the request body, specify at least these required fields: caseType {id}, caseTitle {text}.\n\nYou can add attachments by first calling the attachment API to get an attachments ID, and then including this ID in the Create Case request.\n\nYou can also embed attachment details in the Create Case request.\n\nYou can only include attachment types that are configured on the tenant. You can use GET /helpCase/configuration to determine which attachment types are supported.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/case_e29f5009981f10001e4d862c73b20361"
        },
        "x-workday-multipart-root-part-name": "jsonData"
      }
    },
    "x-workday-multipart-root-part-name": "jsonData"
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/case_e29f5009981f10001e4d862c73b20361"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1292 | Help isn't activated. Access the Innovation Services Opt-In task to activate it in the People Experience section of Available Services. |\n| Critical | A1305 | Select a valid \\~case\\~ type. |\n| Critical | A1306 | The questionnaireHolder value is invalid. |\n| Critical | A1307 | You can only attach files that you own. |\n| Critical | A1308 | You don't have access to the Create About field. |\n| Critical | A1309 | 1 or more attachments are invalid. |\n| Critical | A1311 | You can't attach more than [attachment limit] files to a submission. |\n| Critical | A1312 | Enter a \\~case\\~ title with 140 characters or fewer. |\n| Critical | A1314 | Select a valid \\~worker\\~ for the Create About field. |\n| Critical | A1316 | You don't have access to the Create For field. |\n| Critical | A1317 | The \\~case\\~ and the \\~Case\\~ Questionnaire must have the same \\~case\\~ type. |\n| Critical | A1318 | An attachment can contain an ID or a file but not both. |\n| Critical | A1323 | Select a valid \\~worker\\~ for the Create For field. |\n| Critical | A1325 | You can't create a \\~case\\~ for an external \\~case\\~ type. |\n| Critical | A1327 | You can only submit a questionnaire that you completed yourself. |\n| Critical | A1328 | You’re the \\~case\\~ owner. If this \\~case\\~ is about you, leave this field blank. If it’s about a different \\~worker\\~, enter their name. |\n| Critical | A1329 | This \\~case\\~ must include a questionnaire response. |\n| Critical | A1330 | Select attachment reference IDs that aren't already linked to \\~cases\\~. |\n| Critical | A1331 | Select a \\~Case\\~ Type. |\n| Critical | A1332 | Select different \\~workers\\~ for the Create For and About fields. |\n| Critical | A1333 | Enter a \\~case\\~ title. |\n| Critical | A1335 | The selected \\~case\\~ type should include a questionnaire response. |\n| Critical | A1437 | You can't create a \\~case\\~ for an Integration System User. |\n| Critical | A1664 | You do not have access to the forExternalCreator field. |\n| Critical | A1665 | You cannot create a \\~case\\~ for a blocked external creator. |\n| Critical | A1666 | You cannot enter values for both the forWorker field and the forExternalCreator field. Remove the value from one of these fields. |\n| Critical | A1754 | You have submitted more than one answer for a single select multiple choice question. |\n| Critical | A1755 | You have selected an invalid answer choice. |\n| Critical | A1756 | This questionnaire has already been submitted. You can’t submit it again. |\n| Critical | A1757 | This questionnaire is now closed. You can no longer submit new responses or change your existing responses. |\n| Critical | A1758 | You cannot submit answers to branching questions without answers for parent questions. |\n| Critical | A1759 | All answers you submit must match the expected format for that question type. |\n| Critical | A1761 | All answered questions must be questions from the associated questionnaire. |\n| Critical | A1764 | You must answer all required questions. |\n| Critical | A1765 | You have submitted more multiple choice answers than is allowed for a question. |\n| Critical | A1781 | Could not create a \\~case\\~ for the contact. |\n| Critical | A2576 | Context Instance provided needs to be accessible by the UI task provided. |\n| Critical | A2577 | You need to provide an UI task for the context instance. |\n| Critical | A2578 | The Element Content provided is not available in the UI task provided. |\n| Critical | A2579 | You do not have access to the UI task provided. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "e29f5009981f10001e4ff04a235a0366",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/cases/{ID}/timeline

Retrieves a list of comment timeline items for a case.

Retrieves timeline items for a case. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments, and a questionnaire answer if applicable. <b>Secured By Domain:</b> REST API Public Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a list of comment timeline items for a case.",
  "description": "Retrieves timeline items for a case. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments, and a questionnaire answer if applicable.\n\n<b>Secured By Domain:</b> REST API Public\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
                }
              }
            }
          }
        }
      }
    },
    "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": "46068d08decf100021a18b88a9c20000",
  "x-workday-secured-by-domains": [
    "REST API Public"
  ]
}

GET /helpCase/v4/cases/{ID}/comment/{subresourceID}

Retrieves a comment timeline item for a \~case\~ with the specified comment timeline ID.

Retrieves a comment timeline item for a \~case\~ with the specified comment timeline ID. Comment timeline items include comments and associated attachments. <b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a comment timeline item for a \\~case\\~ with the specified comment timeline ID.",
  "description": "Retrieves a comment timeline item for a \\~case\\~ with the specified comment timeline ID. Comment timeline items include comments and associated attachments.\n\n<b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
          }
        }
      }
    },
    "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": "ce7b0dc1a1c010000f6386eabd370000",
  "x-workday-secured-by-domains": [
    "Help Case Data",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/cases/{ID}/internalNoteTimeline/{subresourceID}

Retrieves an internal note timeline item for a \~case\~ with the specified internal note timeline ID.

Retrieves an internal note timeline item for a \~case\~ with the specified internal note timeline ID. Internal note timeline items include notes, associated attachments, and tagged persons. <b>Secured By Domain:</b> Help Case Internal Notes <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves an internal note timeline item for a \\~case\\~ with the specified internal note timeline ID.",
  "description": "Retrieves an internal note timeline item for a \\~case\\~ with the specified internal note timeline ID. Internal note timeline items include notes, associated attachments, and tagged persons.\n\n<b>Secured By Domain:</b> Help Case Internal Notes\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
          }
        }
      }
    },
    "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": "0d4a742c806110000ec4ed8f552d0000",
  "x-workday-secured-by-domains": [
    "Help Case Internal Notes"
  ]
}

DELETE /helpCase/v4/cases/{ID}/internalNoteTimeline/{subresourceID}

Deletes an internal note.

Deletes an existing internal note from a case. <b>Secured By Domain:</b> Help Case Internal Notes <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Deletes an internal note.",
  "description": "Deletes an existing internal note from a case.\n\n<b>Secured By Domain:</b> Help Case Internal Notes\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. 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 | A1373 | Only a note or note attachment can be deleted. |\n| Critical | A1378 | Only the owner can delete this note. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "0962904747e010001569135c2d610000",
  "x-workday-secured-by-domains": [
    "Help Case Internal Notes"
  ]
}

PATCH /helpCase/v4/cases/{ID}/internalNoteTimeline/{subresourceID}

Edits an internal note.

Edits an existing internal note on a case. <b>Secured By Domain:</b> Help Case Internal Notes <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Edits an internal note.",
  "description": "Edits an existing internal note on a case.\n\n<b>Secured By Domain:</b> Help Case Internal Notes\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/editInternalNoteRequest_a078b68f908e1000117eb0b72f240000"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Updating resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/editInternalNoteRequest_a078b68f908e1000117eb0b72f240000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1367 | Only the owner can edit this note. |\n| Critical | A1371 | Request must contain a \\~Case\\~ note. |\n| Critical | A2603 | Notes with a tagged \\~worker\\~ can't be updated. |\n| Critical | A2604 | Specify a valid note. Notes must contain alphanumeric characters. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "59ab0ea66865100011d765af099d0000",
  "x-workday-secured-by-domains": [
    "Help Case Internal Notes"
  ]
}

POST /helpCase/v4/cases/{ID}/reopen

Updates an existing resolved case instance

Updates an existing resolved case instance with the specified ID. Replaces the existing instance with the specified data in the request body <b>Secured By Domain:</b> Process: Help Cases, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Updates an existing resolved case instance",
  "description": "Updates an existing resolved case instance with the specified ID. Replaces the existing instance with the specified data in the request body\n\n<b>Secured By Domain:</b> Process: Help Cases, Self Service: Help Case Management\n\n<b>Scope:</b> Help",
  "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/reopenReasonRequest_730bdbc0cdd61000298ae4b8a49c0000"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/reopenReasonRequest_730bdbc0cdd61000298ae4b8a49c0000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2424 | Reopen reason cannot be blank. To reopen a \\~case\\~, please provide a reopen reason. |\n| Critical | A2425 | To add a \\~case\\~ reopen reason to a \\~case\\~, you must enable the Enable \\~Case\\~ Owners to Reopen \\~Cases\\~ setting in the Edit Tenant Setup - Help task. |\n| Critical | A2426 | You can’t add a \\~case\\~ reopen reason to a \\~case\\~ that is not in a resolved status. |\n| Critical | A2427 | You can’t reopen the resolved \\~case\\~ unless you’re the \\~case\\~ owner. |\n| Critical | A2428 | Specify a valid value for the \\~case\\~ reopen reason. You can’t add both rich text and plain text in the same reopen reason. |\n| Critical | A2429 | To run this web service, you must activate Workday Help. Access the Innovation Services Opt-in and task to activate it in the People Experience section of the Available Services. |\n| Critical | A2508 | You can't reopen a \\~case\\~ that is closed for more than 7 days. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "d17fc370f3c710001c4ceeac36070000",
  "x-workday-secured-by-domains": [
    "Process: Help Cases",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/cases/{ID}/internalNoteTimeline

Retrieves a list of internal note timeline items for a \~case\~.

Retrieves internal note timeline items for a \~case\~. Internal note timeline items include notes, associated attachments, and tagged persons. <b>Secured By Domain:</b> Help Case Internal Notes <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a list of internal note timeline items for a \\~case\\~.",
  "description": "Retrieves internal note timeline items for a \\~case\\~. Internal note timeline items include notes, associated attachments, and tagged persons.\n\n<b>Secured By Domain:</b> Help Case Internal Notes\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
                }
              }
            }
          }
        }
      }
    },
    "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": "0d4a742c806110000ec4ed8f552d0000",
  "x-workday-secured-by-domains": [
    "Help Case Internal Notes"
  ]
}

POST /helpCase/v4/cases/{ID}/internalNoteTimeline

<b>Secured By Domain:</b> Help Case Internal Notes <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "description": "\n\n<b>Secured By Domain:</b> Help Case Internal Notes\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/timelineNoteRequest_7d92af58ae1210000c818a988dd40000"
        },
        "x-workday-multipart-root-part-name": "jsonData"
      }
    },
    "x-workday-multipart-root-part-name": "jsonData"
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/timelineNoteRequest_7d92af58ae1210000c818a988dd40000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A280 | The file size should not exceed [file size]MB. |\n| Critical | A1290 | Request cannot contain more than [attachment  limit] attachments |\n| Critical | A1379 | This note contains spaces. A note can contain alphanumeric characters or be entirely blank. Remove the spaces or add alphanumeric characters to continue. |\n| Critical | A2580 | Request must contain a note or attachment. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "aa520bc1261e10001c9903dea28c0000",
  "x-workday-secured-by-domains": [
    "Help Case Internal Notes"
  ]
}

GET /helpCase/v4/cases/{ID}

Retrieves a case with the specified ID that the user is secured to view.

Retrieves a case with the specified ID. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam. <b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a case with the specified ID that the user is secured to view.",
  "description": "Retrieves a case with the specified ID. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam.\n\n<b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management\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/caseDetails_c6fb55da58da1000144f81f7eb854c37"
          }
        }
      }
    },
    "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": "c6fb55da58da10000d42ff1f76a149c0",
  "x-workday-secured-by-domains": [
    "Help Case Data",
    "Self Service: Help Case Management"
  ]
}

PATCH /helpCase/v4/cases/{ID}

Edits a case.

Edits a single case instance with the specified data. <b>Secured By Domain:</b> Help Case Data <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Edits a case.",
  "description": "Edits a single case instance with the specified data.\n\n<b>Secured By Domain:</b> Help Case Data\n\n<b>Scope:</b> Help",
  "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/editCase_da54bcb3757f1000136e67dcc2220000"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Updating resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/editCase_da54bcb3757f1000136e67dcc2220000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1104 | Select an active \\~case\\~ type. |\n| Critical | A1343 | \\~Case\\~ is not in changeable status |\n| Critical | A1346 | You can only assign non-confidential \\~cases\\~ to [selectedServiceTeam] |\n| Critical | A1348 | [assignee] doesn't have access to [selectedServiceTeam] \\~cases\\~. |\n| Critical | A1349 | [routedServiceTeam] cannot access \\~cases\\~. Assign the \\~case\\~ to another service team |\n| Critical | A1349 | [selectedServiceTeam] cannot access \\~cases\\~. Assign the \\~case\\~ to another service team |\n| Critical | A1351 | You can only assign non-confidential \\~cases\\~ to [assignee] |\n| Critical | A1355 | The current service team can't access confidential \\~cases\\~. Select a non-confidential \\~case\\~ type. |\n| Critical | A1372 | Select a flag that's currently active. |\n| Critical | A1552 | You must assign the \\~case\\~ to an active service team. |\n| Critical | A2403 | [errors] |\n| Critical | A2628 | Specify an active sub-status. |\n| Critical | A2629 | Specified sub-status is not a sub-status of the specified status. |\n| Critical | A2630 | \\~Case\\~ Status is required. |\n| Critical | A2661 | You can't move confidential \\~cases\\~ to the [service team] service team. Select a non-confidential \\~case\\~ type. |\n| Critical | A2662 | You can't use an external \\~Case\\~ type. Select an internal \\~case\\~ type. |\n| Critical | A2664 | There are inactive labels. Specify a label that's currently active. |\n| Critical | A2675 | You can't specify a service team and reroute the \\~case\\~ in the same request. |\n| Critical | A2727 | You can only reroute when updating \\~case\\~ type. |\n| Critical | A2729 | [assignee] doesn't have access to the service team [routedServiceTeam] this is routed to. |\n| Critical | A2805 | You can't specify a \\~case\\~ type and service team or assignee in the same request. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "016edab9e37f100003a7f7276d5b0000",
  "x-workday-secured-by-domains": [
    "Help Case Data"
  ]
}

GET /helpCase/v4/cases/{ID}/comment

Retrieves a list of comment timeline items for a \~case\~.

Retrieves comment timeline items for a \~case\~. Comment timeline items include comments and associated attachments. <b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a list of comment timeline items for a \\~case\\~.",
  "description": "Retrieves comment timeline items for a \\~case\\~. Comment timeline items include comments and associated attachments.\n\n<b>Secured By Domain:</b> Help Case Data, Self Service: Help Case Management\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
                }
              }
            }
          }
        }
      }
    },
    "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": "ce7b0dc1a1c010000f6386eabd370000",
  "x-workday-secured-by-domains": [
    "Help Case Data",
    "Self Service: Help Case Management"
  ]
}

POST /helpCase/v4/cases/{ID}/comment

<b>Secured By Domain:</b> Process: Help Cases, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "description": "\n\n<b>Secured By Domain:</b> Process: Help Cases, Self Service: Help Case Management\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/caseCommentRequest_08f9349211bf1000249fabb0b2900000"
        },
        "x-workday-multipart-root-part-name": "jsonData"
      }
    },
    "x-workday-multipart-root-part-name": "jsonData"
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/caseCommentRequest_08f9349211bf1000249fabb0b2900000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A280 | The file size should not exceed [file size]MB. |\n| Critical | A1290 | Request cannot contain more than [attachment  limit] attachments |\n| Critical | A1291 | Request must contain a timeline content. |\n| Critical | A1292 | Help isn't activated. Access the Innovation Services Opt-In task to activate it in the People Experience section of Available Services. |\n| Critical | A1293 | This comment contains spaces. A comment can contain alphanumeric characters or be entirely blank. Remove the spaces or add alphanumeric characters to continue. |\n| Critical | A1932 | You cannot add both rich text and plain text in the same comment. |\n| Critical | A2062 | The comment is missing content or contains invalid content. |\n| Critical | A2420 | You can't add a comment or attachment to a resolved \\~case\\~ if reopening resolved \\~cases\\~ is enabled. |\n| Critical | A2774 | You can't send messages if there's no \\~case\\~ owner assigned. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "ce7b0dc1a1c010000f81b1cf6c710000",
  "x-workday-secured-by-domains": [
    "Process: Help Cases",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/cases/{ID}/timeline/{subresourceID}

Retrieves a comment timeline item for a case with the specified timeline ID.

Retrieves a timeline item for a case with the specified timeline ID. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments and a questionnaire answer if applicable. <b>Secured By Domain:</b> REST API Public Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "cases"
  ],
  "summary": "Retrieves a comment timeline item for a case with the specified timeline ID.",
  "description": "Retrieves a timeline item for a case with the specified timeline ID. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments and a questionnaire answer if applicable.\n\n<b>Secured By Domain:</b> REST API Public\n\nContains attachment(s)",
  "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/timelineItem_b5e438c7a5d7100024e5cf5a0a070000"
          }
        }
      }
    },
    "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": "46068d08decf100021a18b88a9c20000",
  "x-workday-secured-by-domains": [
    "REST API Public"
  ]
}

POST /helpCase/v4/externalRecords

Creates and links external records to a Help case.

Creates a single external record instance and links it to a Help case with the specified data. In the request body, specify at least these required fields: [name, href, source:id, and case:id] <b>Secured By Domain:</b> Help External Records <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "externalRecords"
  ],
  "summary": "Creates and links external records to a Help case.",
  "description": "Creates a single external record instance and links it to a Help case with the specified data. In the request body, specify at least these required fields: [name, href, source:id, and case:id]\n\n<b>Secured By Domain:</b> Help External Records\n\n<b>Scope:</b> Help",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/externalRecords_e380afec62fd100014966eab837c0000"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/externalRecords_e380afec62fd100014966eab837c0000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2036 | You must enable external record linking in the Edit Tenant Setup - Help task. |\n| Critical | A2037 | You must define an external record name to link external records to a Help \\~case\\~. |\n| Critical | A2038 | Your external system must have an active link source and access to the target Help \\~case\\~. |\n| Critical | A2039 | The defined external record is already linked to a Help \\~case\\~. |\n| Critical | A2040 | You must define the href to link external records to a Help \\~case\\~. |\n| Critical | A2041 | You cannot link more than [number] external records to a Help \\~case\\~. |\n| Critical | A2051 | The defined external record name exceeds the [limit] character limit. |\n| Critical | A2086 | You must specify a Help \\~case\\~ to add or delete a link to an external record. |\n| Critical | A2093 | The external record href must begin with http:// or https:// |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "e380afec62fd100013fdf9787c510001",
  "x-workday-secured-by-domains": [
    "Help External Records"
  ]
}

PUT /helpCase/v4/externalRecords/{ID}

Deletes an existing link instance between an external record and case.

Deletes an existing link instance between an external record and case with the specified ID and the specified data in the request body. <b>Secured By Domain:</b> Help External Records <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "externalRecords"
  ],
  "summary": "Deletes an existing link instance between an external record and case.",
  "description": "Deletes an existing link instance between an external record and case with the specified ID and the specified data in the request body.\n\n<b>Secured By Domain:</b> Help External Records\n\n<b>Scope:</b> Help",
  "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/delinkExternalRecords_11c712966b95100011ced04d16210000"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data. Updating resource.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/delinkExternalRecords_11c712966b95100011ced04d16210000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A2036 | You must enable external record linking in the Edit Tenant Setup - Help task. |\n| Critical | A2061 | The defined external records is not linked to a Help \\~case\\~. |\n| Critical | A2086 | You must specify a Help \\~case\\~ to add or delete a link to an external record. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "e380afec62fd100013fdf9787c510000",
  "x-workday-secured-by-domains": [
    "Help External Records"
  ]
}

GET /helpCase/v4/configuration

Retrieves tenant setup configurations related to Help Case Management.

Retrieves configuration details including: confidential case message, file configurations, and maximum number of attachments. <b>Secured By Domain:</b> REST API Public

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "configuration"
  ],
  "summary": "Retrieves tenant setup configurations related to Help Case Management.",
  "description": "Retrieves configuration details including: confidential case message, file configurations, and maximum number of attachments.\n\n<b>Secured By Domain:</b> REST API Public",
  "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/configuration_ddc7b3fdde021000143264c9fb23001d"
                }
              }
            }
          }
        }
      }
    },
    "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": "ddc7b3fdde02100015348b8f1b4a001f",
  "x-workday-secured-by-domains": [
    "REST API Public"
  ]
}

GET /helpCase/v4/configuration/{ID}

Retrieves tenant setup configurations related to Help Case Management.

Retrieves configuration details including: confidential case message, file configurations, and maximum number of attachments. <b>Secured By Domain:</b> REST API Public

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "configuration"
  ],
  "summary": "Retrieves tenant setup configurations related to Help Case Management.",
  "description": "Retrieves configuration details including: confidential case message, file configurations, and maximum number of attachments.\n\n<b>Secured By Domain:</b> REST API Public",
  "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/configuration_ddc7b3fdde021000143264c9fb23001d"
          }
        }
      }
    },
    "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": "ddc7b3fdde02100015348b8f1b4a001f",
  "x-workday-secured-by-domains": [
    "REST API Public"
  ]
}

GET /helpCase/v4/caseSuggestions

Retrieves a list of suggestions based on case type.

Each case type can have different suggestions. Suggestions include: Knowledge Base articles, tasks, external links, and learning content. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "caseSuggestions"
  ],
  "summary": "Retrieves a list of suggestions based on case type.",
  "description": "Each case type can have different suggestions. Suggestions include: Knowledge Base articles, tasks, external links, and learning content.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "caseType",
      "in": "query",
      "description": "The Workday ID of the case type to retrieve suggestions for. You can use GET /helpCase/caseTypes/view to retrieve a list of case types and their IDs.",
      "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/caseSuggestion_b07959fa1b8b10001380aeede1a24c14"
                }
              }
            }
          }
        }
      }
    },
    "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": "b07959fa1b8b10001381ecfc3a1e4c17",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/caseSuggestions/{ID}

Retrieves a list of suggestions based on case type.

Each case type can have different suggestions. Suggestions include: Knowledge Base articles, tasks, external links, and learning content. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "caseSuggestions"
  ],
  "summary": "Retrieves a list of suggestions based on case type.",
  "description": "Each case type can have different suggestions. Suggestions include: Knowledge Base articles, tasks, external links, and learning content.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\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/caseSuggestion_b07959fa1b8b10001380aeede1a24c14"
          }
        }
      }
    },
    "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": "b07959fa1b8b10001381ecfc3a1e4c17",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

POST /helpCase/v4/attachments

Uploads an attachment when creating a case.

Uploads 1 attachment per API call. You can only include attachment types that are configured on the tenant. You can use GET /helpCase/configuration to determine which attachment types are supported. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "attachments"
  ],
  "summary": "Uploads an attachment when creating a case.",
  "description": "Uploads 1 attachment per API call.\n\nYou can only include attachment types that are configured on the tenant. You can use GET /helpCase/configuration to determine which attachment types are supported.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\n\n<b>Scope:</b> Help\n\nContains attachment(s)",
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "$ref": "#/components/schemas/caseAttachment_51e444d430be10001f2d7b192137003f"
        },
        "x-workday-multipart-root-part-name": "jsonData"
      }
    },
    "x-workday-multipart-root-part-name": "jsonData"
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/caseAttachment_51e444d430be10001f2d7b192137003f"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A1292 | Help isn't activated. Access the Innovation Services Opt-In task to activate it in the People Experience section of Available Services. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "51e444d430be1000130727499d45001f",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/attachments/{ID}

Will return attachments

Will return attachments <b>Secured By Domain:</b> REST API Public Contains attachment(s)

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "attachments"
  ],
  "summary": "Will return attachments",
  "description": "Will return attachments\n\n<b>Secured By Domain:</b> REST API Public\n\nContains attachment(s)",
  "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/caseAttachment_b661616dd41a1000283daf731d4f0000"
          }
        }
      }
    },
    "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": "b661616dd41a100028c681cee3dc0000",
  "x-workday-secured-by-domains": [
    "REST API Public"
  ]
}

GET /helpCase/v4/externalCreators

Retrieves a collection of external contact details.

Retrieves a collection of external contact details. Contact details include an email address and a name, if applicable. Blocked contacts can't create \~cases\~. <b>Secured By Domain:</b> Help Case External Contacts <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "externalCreators"
  ],
  "summary": "Retrieves a collection of external contact details.",
  "description": "Retrieves a collection of external contact details. Contact details include an email address and a name, if applicable. Blocked contacts can't create \\~cases\\~.\n\n<b>Secured By Domain:</b> Help Case External Contacts\n\n<b>Scope:</b> Help",
  "parameters": [
    {
      "name": "email",
      "in": "query",
      "description": "The email address that identifies the external \\~case\\~ contact.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "hideBlockedCreators",
      "in": "query",
      "description": "If true, blocked contacts are excluded from the response.",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "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/externalCaseContact_556593b34fc61000141177c228360000"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A609 | Invalid email. Enter a valid email address (example@email.com) |\n| Critical | A1675 | The field Email is required and must have a value. |\n| Critical | A1676 | This email address already exists. Enter a different email address. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "b60220e6b8d710000a15b42078bb0000",
  "x-workday-secured-by-domains": [
    "Help Case External Contacts"
  ]
}

POST /helpCase/v4/externalCreators

Creates external \~case\~ contacts.

Creates an instance for an external \~case\~ contact with the specified data. In the request body, specify at lease these required fields: Email. <b>Secured By Domain:</b> Help Case External Contacts <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "externalCreators"
  ],
  "summary": "Creates external \\~case\\~ contacts.",
  "description": "Creates an instance for an external \\~case\\~ contact with the specified data. In the request body, specify at lease these required fields: Email.\n\n<b>Secured By Domain:</b> Help Case External Contacts\n\n<b>Scope:</b> Help",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/externalCaseContact_556593b34fc61000141177c228360000"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/externalCaseContact_556593b34fc61000141177c228360000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A609 | Invalid email. Enter a valid email address (example@email.com) |\n| Critical | A1675 | The field Email is required and must have a value. |\n| Critical | A1676 | This email address already exists. Enter a different email address. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "556593b34fc610001414347f8f720000",
  "x-workday-secured-by-domains": [
    "Help Case External Contacts"
  ]
}

GET /helpCase/v4/externalCreators/{ID}

Retrieves contact details for a single external \~case\~ contact instance.

Retrieves contact details for an external \~case\~ contact with the specified ID. Contact details include an email address and a name, if applicable. <b>Secured By Domain:</b> Help Case External Contacts <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "externalCreators"
  ],
  "summary": "Retrieves contact details for a single external \\~case\\~ contact instance.",
  "description": "Retrieves contact details for an external \\~case\\~ contact with the specified ID. Contact details include an email address and a name, if applicable.\n\n<b>Secured By Domain:</b> Help Case External Contacts\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/externalCaseContact_556593b34fc61000141177c228360000"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n| Severity | Error Code | Validation Message |\n --- | --- | --- |\n| Critical | A609 | Invalid email. Enter a valid email address (example@email.com) |\n| Critical | A1675 | The field Email is required and must have a value. |\n| Critical | A1676 | This email address already exists. Enter a different email address. |",
      "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-internal-try-enabled": "false",
  "x-workday-operation-id": "b60220e6b8d710000a15b42078bb0000",
  "x-workday-secured-by-domains": [
    "Help Case External Contacts"
  ]
}

GET /helpCase/v4/caseTypes

Retrieves a list of case types that a worker has access to.

Retrieves a list of case types that the specified worker has access to. When you don't specify a worker, retrieves a list of case types that the processing worker has access to. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "caseTypes"
  ],
  "summary": "Retrieves a list of case types that a worker has access to.",
  "description": "Retrieves a list of case types that the specified worker has access to. When you don't specify a worker, retrieves a list of case types that the processing worker has access to.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\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"
      }
    },
    {
      "name": "worker",
      "in": "query",
      "description": "The worker to use to determine access to case types.",
      "schema": {
        "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/caseType_94f4c846064010001aa73809d1ed001b"
                }
              }
            }
          }
        }
      }
    },
    "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": "94f4c8460640100019b5cf1caa7d0019",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/caseTypes/{ID}

Retrieves a list of case types that a worker has access to.

Retrieves a list of case types that the specified worker has access to. When you don't specify a worker, retrieves a list of case types that the processing worker has access to. <b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management <b>Scope:</b> Help

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "caseTypes"
  ],
  "summary": "Retrieves a list of case types that a worker has access to.",
  "description": "Retrieves a list of case types that the specified worker has access to. When you don't specify a worker, retrieves a list of case types that the processing worker has access to.\n\n<b>Secured By Domain:</b> Manage: Case Create on Behalf Of, Self Service: Help Case Management\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/caseType_94f4c846064010001aa73809d1ed001b"
          }
        }
      }
    },
    "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": "94f4c8460640100019b5cf1caa7d0019",
  "x-workday-secured-by-domains": [
    "Manage: Case Create on Behalf Of",
    "Self Service: Help Case Management"
  ]
}

GET /helpCase/v4/values/caseLabelCategoriesGroup/caseLabelCategories/

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

Authentication

[
  {
    "OAuth2": []
  }
]

Path-level parameters and metadata

{
  "parameters": [
    {
      "name": "caseLabelCategory",
      "in": "query",
      "description": "The Workday ID of the \\~case\\~ label to return data for.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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/caseLabelCategories_e6734d308df61000165a1df83a060000"
          }
        }
      }
    },
    "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"
}

GET /helpCase/v4/values/externalRecords/source/

Get all sources for External Records

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"
      }
    }
  ],
  "x-workday-confidence-level": "Production"
}

Request, responses and operation details

{
  "tags": [
    "Prompt Values"
  ],
  "description": "Get all sources for External Records",
  "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"
}

GET /helpCase/v4/values/serviceTeamsGroup/serviceTeams/

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"
      }
    },
    {
      "name": "serviceTeam",
      "in": "query",
      "description": "The Workday ID of the service team to return data for.",
      "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/serviceTeams_f417aa04d8631000f078e862a3d80000"
          }
        }
      }
    },
    "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"
}

GET /helpCase/v4/values/caseFlagsGroup/caseFlags/

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

Authentication

[
  {
    "OAuth2": []
  }
]

Path-level parameters and metadata

{
  "parameters": [
    {
      "name": "caseFlag",
      "in": "query",
      "description": "The Workday ID of the \\~case\\~ flag to return data for.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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"
      }
    }
  ],
  "x-workday-confidence-level": "Production"
}

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/caseFlags_4c98b63bd2711000134ad5e215fb0000"
          }
        }
      }
    },
    "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"
}

GET /helpCase/v4/values/caseStatusesGroup/caseStatuses/

Get all \~case\~ statuses.

Authentication

[
  {
    "OAuth2": []
  }
]

Path-level parameters and metadata

{
  "parameters": [
    {
      "name": "caseStatus",
      "in": "query",
      "description": "The Workday ID of the \\~case\\~ status to return data for.",
      "schema": {
        "type": "string"
      }
    },
    {
      "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": "Get all \\~case\\~ statuses.",
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/caseStatuses_c9a9f664e27410000ffb239322300000"
          }
        }
      }
    },
    "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"
}