{ "opencollection": "1.0.0", "info": { "name": "Salesforce Bulk API 2.0 Abort Get API", "version": "v63.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Get", "type": "folder" }, "items": [ { "info": { "name": "Salesforce Get User Info", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/services/oauth2/userinfo", "headers": [ { "name": "Authorization", "value": "example_value" }, { "name": "Content-Type", "value": "example_value" } ] }, "docs": "This requests uses an access token to get user information from Salesforce using the standard `/userinfo` endpoint." }, { "info": { "name": "Salesforce Get Job Info Query", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/query/" }, "docs": "Salesforce Get Job Info Query" }, { "info": { "name": "Salesforce Get Job Query Result", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/query//results", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Salesforce Get Job Query Result" }, { "info": { "name": "Salesforce Get All Query Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/query", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "isPkChunkingEnabled", "value": "true", "type": "query", "description": "If set to true, the request only returns information about jobs where PK Chunking is enabled" }, { "name": "jobType", "value": "example_value", "type": "query", "description": "BigObjectIngest Classic V2Query" }, { "name": "concurrencyMode", "value": "example_value", "type": "query", "description": "serial parallel" }, { "name": "queryLocator", "value": "example_value", "type": "query", "description": "use the value from the nextRecordsUrl from the previous set" } ] }, "docs": "Salesforce Get All Query Jobs" }, { "info": { "name": "Salesforce Get Parallel Results for a Query Job", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/query//resultPages", "headers": [ { "name": "Content-Type", "value": "example_value" }, { "name": "Accept", "value": "example_value" } ] }, "docs": "Retrieves a set of up to 5 job results pages for parallel download." }, { "info": { "name": "Salesforce Get All Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/ingest" }, "docs": "Salesforce Get All Jobs" }, { "info": { "name": "Salesforce Get Job Info", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/jobs/ingest/" }, "docs": "Salesforce Get Job Info" }, { "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 Get Credential", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/named-credentials/credential", "params": [ { "name": "externalCredential", "value": "example_value", "type": "query", "description": "Fully qualified developer name of the external credential." }, { "name": "principalName", "value": "example_value", "type": "query", "description": "Name of the external credential named principal." }, { "name": "principalType", "value": "example_value", "type": "query", "description": "Type of credential principal. Values are:\n* AwsStsPrincipal\n* NamedPrincipal\n* PerUserPrincipal" } ] }, "docs": "Get a credential." }, { "info": { "name": "Salesforce Get External Credentials by Developer Name", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/named-credentials/external-credentials/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get an external credential, including the named credentials and principals associated with it and the type and status of each principal." }, { "info": { "name": "Salesforce Get Named Credential by Developer Name", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/named-credentials/named-credential-setup/:DEVELOPER_NAME", "params": [ { "name": "DEVELOPER_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get a named credential." }, { "info": { "name": "Salesforce Get Named Credential", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/NamedCredential/:NAMED_CREDENTIAL_ID", "params": [ { "name": "NAMED_CREDENTIAL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Named Credential" }, { "info": { "name": "Salesforce Get Table", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/connect/business-rules/decision-table/definitions/:decisionTableId", "params": [ { "name": "decisionTableId", "value": "500123", "type": "path", "description": "Decision Table Id" } ] }, "docs": "# Decision Table Definitions ( GET)\n\nGet details of a decision table definition.\n\nResource\n\n```\n/connect/business-rules/decision-table/definitions/${decisionTableId}\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-table/definitions/0lDxx00000002Ur\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nGET\n\nResponse body for GET\n\n[Decision Table Output](https://developer.salesforce.com/docs/atlas.en-us.industries_re" }, { "info": { "name": "Salesforce Get Test Status", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/einstein/ai-evaluations/runs/:runId", "params": [ { "name": "runId", "value": "500123", "type": "path", "description": "Evaluation ID" } ] }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." }, { "info": { "name": "Salesforce Get Test Results", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/einstein/ai-evaluations/runs/:runId/results", "params": [ { "name": "runId", "value": "500123", "type": "path", "description": "Evaluation ID" } ] }, "docs": "Generates a response based on the specified prompt template and input parameters ([documentation](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_prompt_template.htm))." }, { "info": { "name": "Salesforce Get Conversation Entries", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/connect/conversation/:conversationIdentifier/entries", "params": [ { "name": "conversationIdentifier", "value": "example_value", "type": "path", "description": "Conversation identifier UUID" } ] }, "docs": "Gets in-app messaging conversation entries.\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_conversation_entries.htm" }, { "info": { "name": "Salesforce Get Event Channel", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/PlatformEventChannel/:PLATFORM_EVENT_CHANNEL_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Channel" }, { "info": { "name": "Salesforce Get Channel Member", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/PlatformEventChannelMember/:PLATFORM_EVENT_CHANNEL_MEMBER_ID", "params": [ { "name": "PLATFORM_EVENT_CHANNEL_MEMBER_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Channel Member" }, { "info": { "name": "Salesforce Get Event Relay", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/EventRelayConfig/:EVENT_RELAY_CONFIG_ID", "params": [ { "name": "EVENT_RELAY_CONFIG_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Relay" }, { "info": { "name": "Salesforce Get Event Relay Feedback", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/sobjects/EventRelayFeedback/:EVENT_RELAY_FEEDBACK_ID", "params": [ { "name": "EVENT_RELAY_FEEDBACK_ID", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Event Relay Feedback" }, { "info": { "name": "Salesforce Get Managed Event Subscription by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/ManagedEventSubscription/:managedEventSubscriptionId", "params": [ { "name": "managedEventSubscriptionId", "value": "500123", "type": "path" } ] }, "docs": "Salesforce Get Managed Event Subscription by Id" }, { "info": { "name": "Salesforce Integration Procedure Invocation Using Get", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/apexrest/:NAMESPACE/v1/integrationprocedure/:TYPE_SUBTYPE", "params": [ { "name": "NAMESPACE", "value": "example_value", "type": "path", "description": "The namespace: `omnistudio`, `vlocity_ins`, `vlocity_cmt`, or `vlocity_ps`" }, { "name": "TYPE_SUBTYPE", "value": "example_value", "type": "path", "description": "Type and SubType of the Integration Procedure separated by an underscore." } ] }, "docs": "Salesforce Integration Procedure Invocation Using Get" }, { "info": { "name": "Salesforce Get Active Theme", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/themes/active" }, "docs": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection." }, { "info": { "name": "Salesforce Get Global Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/global" }, "docs": "Get the actions on record detail pages." }, { "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 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/:RELATED_LIST_IDS", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATED_LIST_IDS", "value": "example_value", "type": "path", "description": "Optional. A related list name, or a comma-delimited list of related list names." } ] }, "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 Header Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/list-view/:LIST_VIEW_IDS", "params": [ { "name": "LIST_VIEW_IDS", "value": "example_value", "type": "path", "description": "A single list view ID, or a comma-delimited list of list view 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 Get List View Chart Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/list-view-chart/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "Currently, only `ListViewChartInstance` is valid." } ] }, "docs": "Get the record actions on list views." }, { "info": { "name": "Salesforce Get Lightning Page Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/flexipage/:FLEXIPAGE_NAMES", "params": [ { "name": "FLEXIPAGE_NAMES", "value": "example_value", "type": "path", "description": "A Lightning page name, or a comma-delimited list of Lightning page names." } ] }, "docs": "Get the actions on Lightning pages (FlexiPages)." }, { "info": { "name": "Salesforce Get Lookup Field Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/lookup/:SOBJECT_API_NAMES", "params": [ { "name": "SOBJECT_API_NAMES", "value": "example_value", "type": "path", "description": "A lookup field name, or a comma-delimited list of lookup field names." } ] }, "docs": "Get the actions on Lightning pages (FlexiPages)." }, { "info": { "name": "Salesforce Get Mru List View Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/mru-list/:SOBJECT_API_NAMES", "params": [ { "name": "SOBJECT_API_NAMES", "value": "example_value", "type": "path", "description": "An object name, or a comma-delimited list of object names." } ] }, "docs": "Get the header actions on the most recently used (MRU) list view for objects." }, { "info": { "name": "Salesforce Get Photo Actions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/actions/photo/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path" } ] }, "docs": "Get the photo actions for pages. Currently, only group and user pages support photo actions." }, { "info": { "name": "Salesforce Sobject Get Deleted", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/sobjects/:SOBJECT_API_NAME/deleted", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "start", "value": "example_value", "type": "query" }, { "name": "end", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the list of individual records that have been deleted within the given timespan for the specified object. SObject Get Deleted is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nDeleted records are written to a delete log which this resource accesses. A background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the numbe" }, { "info": { "name": "Salesforce Sobject Get Updated", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/sobjects/:SOBJECT_API_NAME/updated", "headers": [ { "name": "Content-Type", "value": "example_value" } ], "params": [ { "name": "start", "value": "example_value", "type": "query" }, { "name": "end", "value": "example_value", "type": "query" }, { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. SObject Get Updated is available in API version 29.0 and later.\n\nThis resource is commonly used in data replication applications. Note the following considerations:\nResults are returned for no more than 30 days previous to the day the call is executed.\nYour client application can replicate any objects to which it has sufficient permissions. For example, to replic" }, { "info": { "name": "Salesforce Get List Views for an Object", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of a UI API supported object." } ] }, "docs": "Get list views associated with an object." }, { "info": { "name": "Salesforce Get List View Records by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-records/:LIST_VIEW_ID", "params": [ { "name": "LIST_VIEW_ID", "value": "500123", "type": "path", "description": "The ID of a list view." } ] }, "docs": "Get record data for a list view by list view ID using URL parameters." }, { "info": { "name": "Salesforce Get List View Records by Api Name", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of a UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view, such as AllAccounts, __Recent, or __SearchResult." } ] }, "docs": "Get record data for a list view by list view API name using URL parameters." }, { "info": { "name": "Salesforce Get List View Records", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-records/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of the UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get record data for a list view using a request body." }, { "info": { "name": "Salesforce Get List View Metadata by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-info/:LIST_VIEW_ID", "params": [ { "name": "LIST_VIEW_ID", "value": "500123", "type": "path", "description": "The ID of a list view." } ] }, "docs": "Get list view metadata by list view ID using URL parameters." }, { "info": { "name": "Salesforce Get List View Metadata by Api Name", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/list-info/:SOBJECT_API_NAME/:LIST_VIEW_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "API name of the UI API supported object." }, { "name": "LIST_VIEW_API_NAME", "value": "example_value", "type": "path", "description": "API name of a list view, such as AllAccounts, __Recent, or __SearchResult." } ] }, "docs": "Get list view metadata by list view API name using URL parameters." }, { "info": { "name": "Salesforce Get Event Log File", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/sobjects/EventLogFile/:id/LogFile", "params": [ { "name": "id", "value": "abc123", "type": "path", "description": "Log event Id" } ] }, "docs": "Salesforce Get Event Log File" }, { "info": { "name": "Salesforce Get Appointment Slots", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/scheduling/getAppointmentSlots", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of available appointment time slots for a resource based on given work type group and territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentslots.htm" }, { "info": { "name": "Salesforce Get Appointment Candidates", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/scheduling/getAppointmentCandidates", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a list of available service resources (appointment candidates) based on work type group and service territories.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm" }, { "info": { "name": "Salesforce Get Sandbox", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/SandboxInfo/:SANDBOX_INFO_ID", "params": [ { "name": "SANDBOX_INFO_ID", "value": "500123", "type": "path" } ] }, "docs": "Retrieves a sandbox record." }, { "info": { "name": "Salesforce Get Tooling Describe", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects" }, "docs": "Lists the available Tooling API objects and their metadata." }, { "info": { "name": "Salesforce Get Tooling Metadata Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Salesforce Get Tooling Metadata Sobject" }, { "info": { "name": "Salesforce Get Tooling Describe Sobject", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/tooling/sobjects/:SOBJECT_API_NAME/describe", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Salesforce Get Tooling Describe Sobject" }, { "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 a Directory of Supported Objects", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/object-info" }, "docs": "Get a Salesforce org’s active theme. A theme uses colors, images, and banners to change the overall appearance of Salesforce. Administrators can define themes and switch themes to provide a different look. The User Interface API response matches the Admin’s selection." }, { "info": { "name": "Salesforce Get Object Metadata", "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", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path" } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "info": { "name": "Salesforce Get Values for a Picklist Field", "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/:FIELD_API_NAME", "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." }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "Field API Name (optional)" } ] }, "docs": "Get metadata about a specific object. The response includes metadata describing fields, child relationships, record type, and theme." }, { "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 Child Records", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records/:RECORD_ID/child-relationships/:RELATIONSHIP_NAME", "params": [ { "name": "RECORD_ID", "value": "500123", "type": "path", "description": "Record ID" }, { "name": "RELATIONSHIP_NAME", "value": "example_value", "type": "path", "description": "API name of the relationship" } ] }, "docs": "Get child records for a specified record and child relationship name. Relationships are connections between records. On a record detail page, each record in a related list has a child relationship to the parent record." }, { "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 Get a Batch of Records", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/records/batch/:RECORD_IDS", "params": [ { "name": "RECORD_IDS", "value": "example_value", "type": "path", "description": "Comma-separated list of record IDs" } ] }, "docs": "Get data for a batch of records." }, { "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" }, { "info": { "name": "Salesforce Get Lookup Field Suggestions", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/lookups/:SOBJECT_API_NAME/:FIELD_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "sObject API name" }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "Field API name" } ] }, "docs": "When a user edits a lookup field, use this resource to search for and display suggestions. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups." }, { "info": { "name": "Salesforce Get Lookup Field Suggestions for a Specified Object", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/lookups/:SOBJECT_API_NAME/:FIELD_API_NAME/:TARGET_API_NAME", "params": [ { "name": "SOBJECT_API_NAME", "value": "example_value", "type": "path", "description": "The API name of a source object." }, { "name": "FIELD_API_NAME", "value": "example_value", "type": "path", "description": "The API name of a lookup field on the source object." }, { "name": "TARGET_API_NAME", "value": "example_value", "type": "path", "description": "The API name of the target (lookup) object." } ] }, "docs": "When a user edits a lookup field, use this resource to search for and display suggestions for a specified object. You can search for most recently used matches, for matching names, or for any match in a searchable field. You can also specify lookup filter bindings for dependent lookups." }, { "info": { "name": "Salesforce Get Favorites", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/favorites" }, "docs": "Get all of a user’s favorites." }, { "info": { "name": "Salesforce Get a Favorite", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/favorites/:FAVORITE_ID", "params": [ { "name": "FAVORITE_ID", "value": "500123", "type": "path", "description": "The ID of a favorite" } ] }, "docs": "Get a favorite." }, { "info": { "name": "Salesforce Get Apps", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/apps", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" } ] }, "docs": "Get metadata for all the apps a user has access to. Metadata for the selected app includes tabs on the app’s navigation bar. Metadata for other apps doesn’t include tabs on the navigation bar." }, { "info": { "name": "Salesforce Get an App", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/apps/:APP_ID", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" }, { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Get metadata about an app." }, { "info": { "name": "Salesforce Get Last Selected App", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/apps/selected", "params": [ { "name": "formFactor", "value": "example_value", "type": "query", "description": "The form factor for each app that the user has access to (`Large`, `Medium` or `Small`)" } ] }, "docs": "Retrieves the app the current user last selected or the app the user sees by default." }, { "info": { "name": "Salesforce Get Personalized Navigation Items", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/apps/:APP_ID/user-nav-items", "params": [ { "name": "APP_ID", "value": "500123", "type": "path", "description": "Application ID" } ] }, "docs": "Get a user’s personalized navigation items (tabs)." }, { "info": { "name": "Salesforce Get All Navigation Items", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.salesforce.com/services/data/v{version}/jobs/data/v64.0/ui-api/nav-items" }, "docs": "Gets all navigation items (tabs) that the user has access to." } ] } ], "bundled": true }