3.5 KiB
3.5 KiB
name, description
| name | description |
|---|---|
| profile-bulk-import-jobs-routes | Handle 8 OpenAPI operation(s) under /api/profile-bulk-import-jobs for the profile bulk import jobs route group. |
profile bulk import jobs API Routes
Handle 8 OpenAPI operation(s) under /api/profile-bulk-import-jobs for the profile bulk import jobs route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
get_bulk_import_profiles_jobs
- Operation ID:
get_bulk_import_profiles_jobs - Route:
GET /api/profile-bulk-import-jobs - Mode: READ
- Summary: Get Bulk Import Profiles Jobs
- Parameters:
fields[profile-bulk-import-job]inqueryfilterinquerypage[cursor]inquerypage[size]inquerysortinqueryrevisioninheaderrequired
bulk_import_profiles
- Operation ID:
bulk_import_profiles - Route:
POST /api/profile-bulk-import-jobs - Mode: WRITE
- Summary: Bulk Import Profiles
- Parameters:
fields[profile-bulk-import-job]inqueryrevisioninheaderrequired
- Body: JSON request body accepted.
get_bulk_import_profiles_job
- Operation ID:
get_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{job_id} - Mode: READ
- Summary: Get Bulk Import Profiles Job
- Parameters:
job_idinpathrequiredfields[list]inqueryfields[profile-bulk-import-job]inqueryincludeinqueryrevisioninheaderrequired
get_list_for_bulk_import_profiles_job
- Operation ID:
get_list_for_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{id}/lists - Mode: READ
- Summary: Get List for Bulk Import Profiles Job
- Parameters:
idinpathrequiredfields[list]inqueryrevisioninheaderrequired
get_list_ids_for_bulk_import_profiles_job
- Operation ID:
get_list_ids_for_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{id}/relationships/lists - Mode: READ
- Summary: Get List IDs for Bulk Import Profiles Job
- Parameters:
idinpathrequiredrevisioninheaderrequired
get_profiles_for_bulk_import_profiles_job
- Operation ID:
get_profiles_for_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{id}/profiles - Mode: READ
- Summary: Get Profiles for Bulk Import Profiles Job
- Parameters:
idinpathrequiredadditional-fields[profile]inqueryfields[profile]inquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired
get_profile_ids_for_bulk_import_profiles_job
- Operation ID:
get_profile_ids_for_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{id}/relationships/profiles - Mode: READ
- Summary: Get Profile IDs for Bulk Import Profiles Job
- Parameters:
idinpathrequiredpage[cursor]inquerypage[size]inqueryrevisioninheaderrequired
get_errors_for_bulk_import_profiles_job
- Operation ID:
get_errors_for_bulk_import_profiles_job - Route:
GET /api/profile-bulk-import-jobs/{id}/import-errors - Mode: READ
- Summary: Get Errors for Bulk Import Profiles Job
- Parameters:
idinpathrequiredfields[import-error]inquerypage[cursor]inquerypage[size]inqueryrevisioninheaderrequired