{ "opencollection": "1.0.0", "info": { "name": "Salesforce Bulk API 2.0 Abort Record API", "version": "v63.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Record", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get Job Successful Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/ingest//successfulResults" }, "docs": "Salesforce Get Job Successful Record Results" }, { "info": { "name": "Salesforce Get Job Failed Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/ingest//failedResults" }, "docs": "Salesforce Get Job Failed Record Results" }, { "info": { "name": "Salesforce Get Job Unprocessed Record Results", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/ingest//unprocessedrecords" }, "docs": "Salesforce Get Job Unprocessed Record Results" }, { "info": { "name": "Salesforce Record Feed Elements", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/chatter/feeds/record/:RECORD_GROUP_ID/feed-elements", "params": [ { "name": "RECORD_GROUP_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns the feed elements for all the records the context user is following, or all the feed elements of the specified recordId. Use this resource to search a feed or to get the feed elements for a specific feed, including another user’s feed. To use this resource to get the feed elements for a group, specify the group ID as the recordId.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resource_feeds_record.htm" }, { "info": { "name": "Salesforce Get Record Detail Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/record/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "A single record ID, or a comma-delimited list of record IDs." } ] }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Record Edit Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/record/:RECORD_ID/record-edit", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Get the actions on record detail pages." }, { "info": { "name": "Salesforce Get Related List Record Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/record/:RECORD_ID/related-list-record/:RELATED_LIST_RECORD_IDS", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATED_LIST_RECORD_IDS", "value": "example_value", "type": "path", "description": "A related list record ID, or a comma-delimited list of related list record IDs." } ] }, "docs": "Get the actions on records in related lists." }, { "info": { "name": "Salesforce Get List View Record Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/list-view-record/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "A single record ID, or a comma-delimited list of record IDs." } ] }, "docs": "Get the record actions on list views." }, { "info": { "name": "Salesforce Describe Sobject Layouts Per Record Type", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/sobjects/:SOBJECT_API_NAME/describe/layouts/:RECORD_TYPE_ID", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" }, { "name": "RECORD_TYPE_ID", "value": "500123", "type": "path" } ] }, "docs": "Returns a list of layouts and descriptions. The list of fields and the layout name are returned." }, { "info": { "name": "Salesforce Record Count", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/limits/recordCount", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "sObjects", "value": "example_value", "type": "query", "description": "A comma-delimited list of object names. If a listed object is not found in the org, it is ignored and not returned in the response.\nThis parameter is optional. If this parameter is not provided, the resource returns record counts for all objects in the org." } ] }, "docs": "Lists information about object record counts in your organization.\nThis resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:\n\nDeleted records in the recycle bin.\nArchived records.\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm" }, { "info": { "name": "Salesforce Get Record Data and Object Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/record-ui/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "Comma-separated list of record IDs" } ] }, "docs": "Get layout information, metadata, and data to build UI for a single record or for a collection of records.\nThe response contains layout information for whichever layout types are specified in the layoutTypes parameter.\n\nIt contains data for the records specified in the recordIds parameter.\n\nThe response contains object metadata for the object types of the records specified in the recordIds parameter, and for any nested objects. For example, a request to /ui-api/record-ui/001RM000003RsOHYA0, whic" }, { "info": { "name": "Salesforce Get Record Layout Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/layout/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get metadata about page layouts for the specified object type." }, { "info": { "name": "Salesforce Get Values for All Picklist Fields of a Record Type", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/object-info/:SOBJECT_API_NAME/picklist-values/:RECORD_TYPE_ID", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Object API Name" }, { "name": "RECORD_TYPE_ID", "value": "500123", "type": "path", "description": "Record type Id. Use `012000000000000AAA` as default when there are no custom record types." } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "info": { "name": "Salesforce Get a Record", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path" } ] }, "docs": "Get a record’s data." }, { "info": { "name": "Salesforce Update a Record", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a record's data.\nUser Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an Error with Output.\n\nWhen you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the If-Modified-Since HTTP header in the request.\n\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." }, { "info": { "name": "Salesforce Delete a Record", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Update a record's data.\nUser Interface API enforces Salesforce validation rules. If a validation rule fails, the response is an Error with Output.\n\nWhen you make a PATCH request to update a record, make sure that the record hasn’t changed since the user started editing it. To find out whether it’s safe to save a record, pass the If-Modified-Since HTTP header in the request.\n\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." }, { "info": { "name": "Salesforce Create a Record", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records", "body": { "type": "json", "data": "{}" } }, "docs": "Create a record. First, make a request to the Clone Record Default or Create Record Default resources to get the default metadata and data for the record.\nAs of API version 43.0, if you pass read-only fields in a request body, the response is an Error with Output." }, { "info": { "name": "Salesforce Get Default Values to Clone a Record", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/record-defaults/clone/:RECORD_ID", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" } ] }, "docs": "Get the default layout information, object information, and data for cloning a record. After getting the default values, make a request to POST /ui-api/records to create the record.\nThe response contains the default field values for a record cloned from the record specified in , optionally of the specified recordTypeId.\n\nIt also contains the corresponding layout information for edit mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a fie" }, { "info": { "name": "Salesforce Get Default Values to Create a Record", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/record-defaults/create/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "sObject API name" } ] }, "docs": "Get the default values for fields for a new record of a specified object and optional record type. After getting the default values, make a request to POST /ui-api/records to create the record.\nThe response contains the default field values for the Full layout type for a new record of the object type specified in .\n\nIt also contains the corresponding layout for create mode. In the Salesforce user interface, an admin with “Customize Application” permission can mark a field as re" } ] } ], "bundled": true }