j
Jobs
1.0.0
API Overview
The Jobs API provides endpoints for managing and monitoring job executions within Salesforce Commerce Cloud.
Overview
This API allows administrators to search for job executions, trigger new job runs, retrieve execution details, and abort running jobs. Jobs represent scheduled or on-demand tasks that perform operations such as data import/export, indexing, and cleanup.
Key Features
- Job Execution Search: Use complex queries to search for job executions by various attributes
- Job Triggering: Create new job executions to run jobs on demand
- Execution Monitoring: Retrieve detailed information about job executions including step-level details
- Job Abort: Delete or abort running job executions
Searchable Attributes
The following attributes can be used in search queries:
id: The unique identifier of the job execution (String)jobId: The identifier of the job (String)status: The execution status (String)startTime: The start time of the execution (DateTime)endTime: The end time of the execution (DateTime)
Sortable Attributes
Search results can be sorted by:
id: Sort by execution identifierjobId: Sort by job identifierstatus: Sort by execution statusstartTime: Sort by start timeendTime: Sort by end time
Use Cases
- Monitoring: Track job execution status and progress
- Troubleshooting: Investigate failed job executions and review step details
- Automation: Trigger job executions programmatically
- Reporting: Generate reports on job execution history and performance
Authentication
This API requires OAuth 2.0 authentication with the appropriate scopes:
sfcc.jobs- Read access to job resourcessfcc.jobs.rw- Read and write access to job resources
Best Practices
- Use specific search queries to find job executions efficiently
- Monitor long-running jobs by polling the get execution endpoint
- Use pagination for large result sets when searching executions
- Check execution status before attempting to abort a job
- Review step execution details for debugging failed jobs
https://{shortCode}.api.commercecloud.salesforce.com/operation/jobs/v1
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!