--- category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Workday Extend, Platform and Product Extensions/Integration] keyword: [Extend, Model Components, Extend Business Objects, MCBO, Model Component Business Objects, Business Objects, Model BO] nav: wcp_docs parent_url: /wcp_docs/ title: >- Reference: Business Object API Requests layout: subsection --- Each business object you create generates an API in the form of: ``` https://{basePath}/apps/{appId}/v1/{defaultCollectionName} ``` where: - `{basePath}`: The regional URL base path. - `{appId}`: The reference ID of the Extend app. - `{defaultCollectionName}`: The default collection name of the business object. Example: charities. The Business Object API supports these HTTP methods: - GET - POST - PUT - PATCH - DELETE You can use all of the fields defined on the business object in the request body. Workday Extend also generates query parameters for all indexed (`SINGLE_INSTANCE`) fields of Extend business objects. For more information, see [Example: Query Parameters in Business Object API Requests](/wcp_docs/iuv1669766878068.html). Note: To access the Business Object API from an external app, you must: - Create an OAuth 2.0 API client on the Workday Developer Site. - Select the Workday-Owned scope to access the resources. ## Example: Create a Charity Object API Endpoint: https://api.workday.com/apps/charitableDonations_abcdef/v1/charities Operation: - POST Headers: - Content-Type : application/json. - Authorization : Bearer + token (your app uses this token to make all access requests for the API Gateway). Request Body: ``` { "name": "Alameda County Food Bank", "description": "Distributing millions of healthy meals every year.", "matchDonations": true, "relationshipManager": {"id":"Employee_ID=21001"} } ``` cURL Request: ``` curl --request POST \ --url https://api.workday.com/apps/charitableDonations_abcdef/v1/charities/ \ --header 'authorization: Bearer [token]' \ --header 'content-type: application/json' \ --data '{ "name": "Alameda County Food Bank", "description": "Distributing millions of healthy meals every year.", "matchDonations": true, "relationshipManager": {"id":"Employee_ID=21001"} }' ``` ## Example: Update a Charity Object API Endpoint: https://api.workday.com/apps/charitableDonations_abcdef/v1/charities/{charityWID} Operation: - PUT Headers: - Content-Type : application/json. - Authorization : Bearer + token (your app uses this token to make all access requests for the API Gateway). Request Body: ``` { "name": "Alameda County Food Bank", "description": "Distributing millions of healthy meals every year.", "matchDonations": true, "relationshipManager": {"id":"Employee_ID=21001"} } ``` cURL Request: ``` curl --request PUT \ --url https://api.workday.com/apps/charitableDonations_abcdef/v1/charities/charityWID \ --header 'authorization: Bearer [token]' \ --header 'content-type: application/json' \ --data '{ "name": "Alameda County Food Bank", "description": "Distributing millions of healthy meals every year.", "matchDonations": true, "relationshipManager": {"id":"Employee_ID=21001"} }' ``` Operation: - PATCH Headers: - Content-Type : application/json. - Authorization : Bearer + token (your app uses this token to make all access requests for the API Gateway). Request Body: ``` { "matchDonations": false, "relationshipManager": {"id":"Employee_ID=21002"} } ``` cURL Request: ``` curl --request PATCH \ --url https://api.workday.com/apps/charitableDonations_abcdef/v1/charities/charityWID \ --header 'authorization: Bearer [token]' \ --header 'content-type: application/json' \ --data '{ "matchDonations": false, "relationshipManager": {"id":"Employee_ID=21002"} }' ``` Note: Only apps deployed to a WCP Development tenant after November 10, 2020 support the PATCH operation. ## Bulk Operations The POST, PUT, PATCH, and DELETE methods support bulk operations. To create, update, or delete up to 100 instances of a business object in a single request, append the `?bulk=true` query parameter to the HTTP request URL. Note: For the PUT, PATCH, and DELETE methods, you must include the instance ID in the request body. Bulk POST Request URL: ``` POST https://api.workday.com/apps/charitableDonations_abcdef/v1/charities?bulk=true ``` Bulk POST Request Body: ``` { "data": [ { "name": "Employee Assistance Program", "description": "Assist your fellow employees in their time of need. Charitable donations support employees through natural disasters, unexpected loss, and other hardships.", "matchDonations": true, "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } }, { "name": "Animal Welfare", "description": "Your charitable donations will provide animal training and veterinary services, and equip trusted organizations to protect animals from abuse.", "matchDonations": false, "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } } ] } ``` Bulk PUT Request URL: ``` PUT https://api.workday.com/apps/charitableDonations_abcdef/v1/charities?bulk=true ``` Bulk PUT Request Body: ``` { "data": [ { "id": "bd304b424c3f812705b509291a007505", "name": "Employee Assistance Program", "description": "Assist your fellow employees in their time of need. Charitable donations support employees through natural disasters, unexpected loss, and other hardships.", "matchDonations": true, "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } }, { "id": "bd304b424c3f811cb5cc09291a007605", "name": "Animal Welfare", "description": "Your charitable donations will provide animal training and veterinary services, and equip trusted organizations to protect animals from abuse.", "matchDonations": false, "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } } ] } ``` Bulk PATCH Request URL: ``` PATCH https://api.workday.com/apps/charitableDonations_abcdef/v1/charities?bulk=true ``` Bulk PATCH Request Body: ``` { "data": [ { "id": "bd304b424c3f812705b509291a007505", "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } }, { "id": "bd304b424c3f811cb5cc09291a007605", "relationshipManager": { "descriptor": "James Moore (Recruiter, 1000)", "id": "f21231394b71433c8f75f6fe78264f33" } } ] } ``` Bulk DELETE Request URL: ``` DELETE https://api.workday.com/apps/charitableDonations_abcdef/v1/charities?bulk=true ``` Bulk DELETE Request Body: ``` { "data": [ { "id": "bd304b424c3f812705b509291a007505" }, { "id": "bd304b424c3f811cb5cc09291a007605" } ] } ``` Note: You can't use the bulk DELETE operation in your PMD. ### Related Information [Reference: Workday Extend API Gateways and Authorization Base URLs](/wcp_docs/dlh1653340161856.html) [Example: Order of Responses in Bulk Operations on Business Objects](/wcp_docs/xfx1669051402755.html)