### XML Response Format Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/cpq1623708996945.html Example of a successful API response containing instance metadata. ```xml ``` -------------------------------- ### Success Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/oru1623709232070.html Example of a successful publish operation response indicating three changes were published. ```xml ``` -------------------------------- ### API Response XML Examples Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/qkq1623708997555.html Examples of successful and failed API responses in XML format. ```xml ``` ```xml There are duplicate mapping conditions. Make all mappingCriterion conditions unique ``` -------------------------------- ### Unpublished Changes Status Response Examples Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/zrk1623709232978.html Examples showing the XML response structure when admin publishing is enabled versus disabled. ```xml ``` ```xml ``` -------------------------------- ### XML Response Format Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/rsm1623709205180.html Example of the XML structure returned by the API, showing the hierarchy of response, output, currencies, and individual currency elements. ```xml ``` -------------------------------- ### API Success Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/rdj1623709195947.html Example of a successful API response containing account details and warning messages. ```xml You have unpublished changes. Your changes will not be visible every where until it is published. ``` -------------------------------- ### Error Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/oru1623709232070.html Example of an unsuccessful publish operation response containing error messages and counts of unpublished changes. ```xml Publish Error ``` -------------------------------- ### API Error Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/data-submission-methods/ifw1623709245867.html Example of an XML response indicating a failed import with specific error and warning messages. ```xml Import Failed with the following error: No transactions were imported or deleted during the import. Additional information: Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12. Invalid Dimension Choice: Invoice12 on row 1 column B ``` -------------------------------- ### API Error Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/rdj1623709195947.html Example of an unsuccessful API response indicating an error with the provided account ID. ```xml Invalid account id: "-50" ``` -------------------------------- ### Sequence of Three Renames Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/skf1623708608121.html Example of a three-step rename sequence for entity IDs. ```text ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA ``` -------------------------------- ### createLevel XML Request Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/mye1623709199118.html Example XML request structure for the createLevel method, including credentials and level details. ```xml ``` -------------------------------- ### Simple Name Swap ID Mapping Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/skf1623708608121.html Example of a simple name swap for entity IDs in a remote system. ```text ID Unique Value New Unique Value 1 AA BB 2 BB AA ``` -------------------------------- ### API XML Response Structure Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/dpj1623709239211.html Example of the XML response returned after a successful user update operation. ```xml ``` -------------------------------- ### XML Response Format for Permission Sets Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/bpq1623709219931.html Example of the XML structure returned by the API when querying permission sets. ```xml ``` -------------------------------- ### Handle API Response Without Spreadsheet Errors Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/ess1623709233961.html Example of a successful HTTP response with text/xml content type. ```http HTTP/1.1 200 OK Content-Type: text/xml;charset=UTF-8 Dimension Access Control is not enabled in this instance. ``` -------------------------------- ### XML Request File Content Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/skf1623708608121.html Example XML files used for the request and content parameters in the cURL command. ```xml ``` ```xml ``` -------------------------------- ### Sample Original Request XML with Versions Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/dxz1623709678599.html Set version availability for parent levels before child levels to prevent compatibility errors. ```xml ``` -------------------------------- ### ConfigurableModel XML Response Example Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/xtz1623709218885.html Example of the XML structure returned for a ConfigurableModel, including Dimension and Driver definitions. ```xml ``` -------------------------------- ### Sample Original Request XML with Account Attributes Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/vmq1623709241215.html Example of a valid XML payload where account attributes are correctly assigned to parent and child accounts. ```xml ``` -------------------------------- ### Account API Response Examples Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/mbw1623709234932.html XML structures representing successful account updates with warnings and failed requests with error messages. ```xml You have unpublished changes. Your changes will not be visible every where until it is published. ``` ```xml Invalid account id: "-50" ``` -------------------------------- ### Sample Original Request XML with Level Attributes Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/dxz1623709678599.html Demonstrates the correct hierarchical assignment of location attributes to parent and child levels. ```xml ``` -------------------------------- ### exportInstances Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/cpq1623708996945.html Retrieves metadata for the complete list of all instances of Adaptive Planning to which the user has access. ```APIDOC ## exportInstances ### Description Returns metadata for the complete list of all instances of Adaptive Planning to which this user has access. If the Multiple Instance feature is not enabled, it returns the instance to which the user belongs. ### Request Format ```xml ``` ### Parameters #### credentials element - **login** (string) - Required - The login name of the user invoking the API method. - **password** (string) - Required - The password of the user invoking the API method. - **locale** (string) - Optional - Specify the locale to be used to interpret incoming numbers and dates. - **instanceCode** (string) - Optional - Specify an instance other than the default instance. #### include element - **accessibleInstances** (boolean) - Optional - Whether the response should include other instances besides the single instance specified in the credentials. ``` -------------------------------- ### Non-streaming response format Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/mdn1623709213322.html Example of a standard XML response for a non-streaming data export. ```xml Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014 ``` -------------------------------- ### Update User Request Format Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/dpj1623709239211.html Example XML structure for the updateUser method, demonstrating the required credentials and user elements. ```xml ``` -------------------------------- ### recalculateSheet XML Request Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/data-submission-methods/mzo1623709248617.html Example of the XML structure required to invoke the recalculateSheet method. ```xml ``` -------------------------------- ### GET /api/rest/v1/{tenant}/tasks Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/rest-apis-json-/service-tasks/tasks.html.html Retrieves a list of integration tasks defined in the instance. ```APIDOC ## GET /api/rest/v1/{tenant}/tasks ### Description Retrieves the details of integration tasks defined in the instance. ### Method GET ### Endpoint /api/rest/v1/{tenant}/tasks ### Parameters #### Path Parameters - **tenant** (string) - Required - The customer instance code #### Query Parameters - **limit** (number) - Optional - The number of integration tasks to include in the result (1-100). - **offset** (number) - Optional - The number of tasks to skip before starting to include tasks in the results. - **taskType** (string) - Optional - Filter the retrieved tasks by their task type (e.g., integration). ### Response #### Success Response (200) - **count** (number) - The total number of customer integration tasks. - **data** (array) - A collection of integration tasks containing id and name. #### Response Example { "count": 3, "data": [ { "id": "integration4", "taskType": "integration", "name": "An Integration Task" } ] } ``` -------------------------------- ### API Response XML Structure Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/sjw1623709215263.html Example of a successful API response containing a logo URL. ```xml ``` -------------------------------- ### Create Account XML Request Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/rdj1623709195947.html Use this XML structure to define a new account, including parent ID, account details, and custom attributes. ```xml ``` -------------------------------- ### API Response XML Structure Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/data-submission-methods/qjl1623709247663.html Example of a successful API response containing status messages. ```xml Successfully erased actuals data. 4 facts deleted. 2 notes deleted. 1 splits deleted. ``` -------------------------------- ### Full HTTP POST Request for updateAccessRules Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/ess1623709233961.html A complete example of a multipart/form-data POST request including the boundary definition, XML payload, and file attachment. ```http POST https://api.adaptiveplanning.com/api/v24 Content-Type: multipart/form-data; boundary=WebAppBoundary --WebAppBoundary Content-Disposition: form-data; name="request" Content-Type: text/xml --WebAppBoundary Content-Disposition: form-data; name="content"; filename="access_rules_template.xlsx" < access_rules_template.xlsx --WebAppBoundary-- ``` -------------------------------- ### API Error Response Structure Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/twc1623709231226.html Example of an XML response indicating a failure during the creation of a modeled sheet. ```xml Caught Exception: Failed to create modeled sheet. ``` -------------------------------- ### Handle API Response With Spreadsheet Errors Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/ess1623709233961.html Example of a multipart/mixed response containing an error report spreadsheet. ```http HTTP/1.1 200 OK Content-Type: multipart/mixed; boundary=----AdaptivePlanningAPIBoundary173bb6faa3d ------AdaptivePlanningAPIBoundary173bb6faa3d Content-type: text/xml; charset=UTF-8 Error occurred, refer the error sheet for detailed error. ------AdaptivePlanningAPIBoundary173bb6faa3d Content-Disposition: attachment; filename="Error Report.xlsx" Content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Content-Transfer-Encoding: base64 ``` -------------------------------- ### createAccount Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/vav1623709197180.html Method used to create a new account within the system. ```APIDOC ## createAccount ### Description Creates a new account in the system. ``` -------------------------------- ### Entity Rename Scenarios Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/dxz1623709678599.html Examples of how the API tracks entity IDs across name swaps and new entity introductions. ```text ID Unique Value New Unique Value 1 AA BB 2 BB AA ``` ```text ID Unique Value New Unique Value 1 AA BB 2 BB CC 3 CC AA ``` ```text ID Unique Value New Unique Value 4 AA 1 AA BB 2 BB Old BB ``` -------------------------------- ### API Error Response XML Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/bgx1623709237195.html Example of an error response indicating an invalid attribute value ID. ```xml Invalid attribute value id: "-50" ``` -------------------------------- ### API Response XML Structure Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/aos1623709222711.html Example of a successful API response containing a collection of audit events. ```xml ``` -------------------------------- ### POST https://api.adaptiveplanning.com/api/v24 Source: https://doc.workday.com/adaptive-planning/en-us/workday-adaptive-planning-documentation/integration/managing-data-integration/api-documentation/metadata-and-data-create-update-and-read-methods/ess1623709233961.html Uploads access rules by sending an XML request and an Excel spreadsheet file. ```APIDOC ## POST https://api.adaptiveplanning.com/api/v24 ### Description Uploads access rules to the Adaptive Planning instance using a multipart request containing an XML configuration and an Excel spreadsheet. ### Method POST ### Endpoint https://api.adaptiveplanning.com/api/v24 ### Request Body - **request** (text/xml) - Required - The XML configuration file (e.g., updateAccessRules.xml). - **content** (file) - Required - The Excel spreadsheet file containing the access rules data. ### Response #### Success Response (200) - **Content-Type: text/xml** - Returned when the request succeeds or for general errors. - **Content-Type: multipart/mixed** - Returned when the spreadsheet contains errors, including an XML status part and a base64 encoded error report spreadsheet. ```