Enterprise Data Catalog REST API Reference > Monitoring Info REST APIs > Monitoring Information REST APIs
  

Monitoring Information REST APIs

You can use the following Monitoring Information REST APIs to download logs, view job status, list jobs, and submit jobs:
Monitoring Info REST API
Description
GET jobs
Lists the jobs and their job details
GET jobs/{id}
Lists the job details for a job
GET jobs/{id}/logs
Lists the logs for a job
GET jobs/{id}/logs/zip
Downloads the logs generated for a job to a ZIP file
GET jobs/{id}/status
View the job status
PUT jobs/{id}/status
Updates the job status of a job
GET jobs/backup
Lists the job details for the job that backs up the catalog
POST jobs/backup
Submits the job to back up the catalog
GET jobs/backup/{id}
Lists the backup job configuration
GET backup/{id}/result
Downloads the ZIP file for the backup job
GET jobs/objectExports
Lists the jobs of object export type and their job details
POST jobs/objectExports
Submits the job configuration to export objects
GET jobs/objectExports/{id}
Lists the job configuration for an object export job
GET jobs/objectExports/{id}/result
Downloads the CSV file that contains the object export jobs and their job details
GET jobs/objectImports
Lists the jobs of object import type and their job details
POST jobs/objectImports
Submits the job configuration to import objects
GET jobs/objectImports/{id}
Lists the job configuration for an object import job
GET jobs/resourceExports
Lists the jobs of resource export type and their job details
POST jobs/resourceExports
Submits the job configuration to export resources
GET jobs/resourceExports/{id}
Lists the resource export jobs and their job details
GET jobs/resourceExports/{id}/result
Downloads the CSV file that contains the resource export jobs and their job details
GET /jobs/resourceScanLogs
Lists the resource scan log jobs and their job details
POST /jobs/resourceScanLogs
Submits a resource scan log job to list the resource scan logs
GET jobs/resourceScanLogs/{id}/result
Downloads the resource scan logs for a job
GET jobs/searchExports
Lists the jobs of search export type and their job details
POST jobs/searchExports
Submits the search export job configuration to export search results
GET jobs/searchExports/{id}
Lists the job details of a search export job
GET jobs/searchExports/{id}/result
Downloads the CSV file that contains the search export jobs and their job details
GET jobs/serviceLogs
Lists the jobs of service log type and their job details
POST jobs/serviceLogs
Submits a service log job to list the service logs
GET jobs/serviceLogs/{id}/result
Downloads the resource scan logs for a job

List the Job Details

jobs
API to list the jobs and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
jobType
Optional
Enter one or more job types to view the job details.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs?jobId=345245&offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

List the Details for a Job

jobs/{id}
API to list the job details of a job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job
Path
String

Response Codes

Code
Reason
200
Listed the job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/54345" -H "accept: application/json"

List the Logs for a Job

jobs/{id}/logs
API to list the logs for a job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/{id}/logs
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Listed the logs for the job.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/4523/logs" -H "accept: application/json"

Download the Logs Generated for a Job to a ZIP file

jobs/{id}/logs/zip
API to download the logs generated for a job to a ZIP file. You can view and download the zip file from the Downloads folder on your machine.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/{id}/logs/zip
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/765456/logs/zip" -H "accept: application/zip"

View a Job Status

jobs/{id}/status
API to view the job status.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/{id}/status
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Returns the job status as running, completed, failed, or submitted.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/69584/status" -H "accept: application/json"

Update the Job Status

jobs/{id}/status
API to update the job status of a job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/{id}/status
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String
status
Required
Enter the status to assign to the job. For example, enter RUNNING as the job status.
Body
-

Response Codes

Code
Reason
200
Updated the job status.
201
Created.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/654/status" -H "accept: application/json" -H "Content-Type: application/json" -d "\"Completed\""

List the Job Details about the Backup Job

jobs/backup
API to list the backup job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/backup
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the logs for the job.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/backup?offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit the Backup Job

jobs/backup
API to submit the backup job to back up the catalog.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/backup
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Required
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
fileLocation
Optional
Delete the term 'string' and then enter the path of backup ZIP file located on your machine or leave it blank. Do not enter the file name.
If the file location is blank, the Catalog service uses the backup file in the following location:
$<INFA_HOME>/logs/<NodeName>/services/CatalogService/<CatalogServiceName>/JobsStore/
Note: When you submit the job, an error appears if you do not have read and write access to the file.
String
maxCores
Optional
The maximum number of resources that can be used in an export job.
Default is 15.
Integer
maxParallelism
Optional
The maximum number of table backups to run in parallel.
Default is 0.
Integer
maxRetries
Optional
The maximum number of retries to check for the availability of resources.
Default is 5.
Integer
stores
Optional
Provide the required data store that you want to back up or a comma-separated list of data stores that you want to back up.
Based on the issues you want to troubleshoot, you can back up the required data stores instead of taking a complete backup of the catalog.
You can use the following options to back up the required data stores in the catalog:
  • - ALL
  • - STAGING
  • - GRAPH
  • - SEARCH
String

Response Codes

Code
Reason
200
Submitted the job configuration.
201
Created.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/backup" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"fileLocation\": \"string\", \"maxCores\": 0, \"maxParallelism\": 0, \"maxRetries\": 0" \"stores\": \"STAGING\",\"GRAPH\"}

List the Job Details for a Backup Job

jobs/backup/{id}
API to list the backup job configuration.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/backup/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the backup job.
Path
String

Response Codes

Code
Reason
200
Listed the job details for the backup job.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/backup/3425" -H "accept: application/json"

Download the ZIP file of the Backup Job

jobs/backup/{id}/result
API to download the ZIP file for the backup job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/backup/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/backup/3434/result" -H "accept: application/zip"

List the Job Details for Object Export Jobs

jobs/objectExports
API to list the jobs of object export type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the object export jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports?jobId=694874&offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit the Job Configuration to Export Objects

jobs/objectExports
API to submit the job configuration to the catalog for object export task.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Required
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
attributeIds
Required
List comma-separated attributes to export.
String
Enter the IDs, separated by commas.
excludeChildren
Optional
Excludes the children of the objects from object export. Default is true.
Boolean
Provide one of the following values:
  • - true
  • - false
includeReferenceObjects
Optional
Includes the reference objects in object export. Default is true.
Boolean
Provide one of the following values:
  • - true
  • - false
objectId
Required
The ID of the object.
String
-

Response Codes

Code
Reason
200
Bulk object export response.
201
Created
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"attributeIds\": [ \"com.infa.at1\" ], \"excludeChildren\": true, \"includeReferenceObjects\": true, \"objectId\": \"3421\"}"

List the Job Configuration for an Object Export Job

jobs/objectExports/{id}
API to list the job configuration for an object export job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Listed the job configuration.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports/567356456" -H "accept: application/json"

Download the File with Object Export Jobs

jobs/objectExports/{id}/result
API to download the CSV file that has the job details about object export jobs.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the object export job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports/985634/result" -H "accept: application/excel"

List the Job Details for Object Import Jobs

jobs/objectImports
API to list the jobs of object import type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the object import jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports?jobId=&offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit the Job Configuration to Import Objects

jobs/objectImports
API to submit the job configuration to the catalog for object import task.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
file
Optional
Choose the file to import objects.
formData
file
packages
Optional
Comma-separated list of packages to import.
formData
-
emailId
Optional
Email address of the user.
formData
-

Response Codes

Code
Reason
200
Bulk object import response.
201
Created
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "packages=pa32"

List the Job Configuration for an Import Job

jobs/objectImports/{id}
API to list the job configuration for an object import job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job
Path
String

Response Codes

Code
Reason
200
Bulk object import configuration
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectImports/95867" -H "accept: application/json"

List the Job Details for Resource Export Jobs

jobs/resourceExports
API to list the jobs of resource export type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the object resource jobs and their job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports?offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit the Job Configuration to Export Resources

jobs/resourceExports
API to submit the job configuration to the catalog for resource export task.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Required
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
attributeIds
Required
List comma-separated attributes to be exported.
String
Enter the IDs, separated by commas.
classType
Required
List comma-separated class types to be exported.
String
Enter the IDs, separated by commas.
includeReferenceObjects
Optional
Includes the reference objects in object export. Default is true.
Boolean
Provide one of the following values:
  • - true
  • - false
resourceName
Required
The ID of the resource.
String
-

Response Codes

Code
Reason
200
Bulk resource export response.
201
Created
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"attributeIds\": [ \"com.infa.at1\" ], \"excludeChildren\": true, \"includeReferenceObjects\": true, \"objectId\": \"3421\"}"

List the Job Details for a Resource Export Job

jobs/resourceExports/{id}
API to list the jobs of resource export type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Listed the resource export job and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports/45367" -H "accept: application/json"

Download the File with Resource Export Jobs

jobs/resourceExports/{id}/result
API to download the CSV file that has the job details about resource export jobs.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the resource export job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceExports/45342/result" -H "accept: application/excel"

List the Job Details for a Resource Scan Log Job

jobs/resourceScanLogs
API to list the resource scan log jobs and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceScanLogs
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs?jobId=345245&offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit a Resource Scan Log Job

jobs/resourceScanLogs
API to submit a resource scan log job to list the resource scan logs.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceScanLogs
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Required
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
appDate
Optional
Enter the date in YYYY-MM-DD hh:mm:ss, YYYY-MM-DD hh:mm, or YYYY-MM-DD format.
Returns the resource scan logs from appDate to the current date.
String
includeProfilingLogs*
Optional
Enter true to collect Data Integration logs for profiling for the resources.
Boolean
includeScannerLogs*
Optional
Enter true to collect resource YARN logs.
Boolean
resourceName
Required
List of resource names.
Returns the scan logs for the listed resources.
Array [String]
*If you configure the LdmCustomOptions.ldm.exclusive.mode custom property to true for the Catalog Service, the service collects only the resource YARN logs. If you configure the property to false, the service collects resource YARN logs and Data Integration logs for profiling. Recycle the Catalog Service after you change the custom property.
To configure this property, navigate to the Informatica Administrator > Manage > Services and Nodes > Catalog Service > Custom Properties section.

Response Codes

Code
Reason
200
Updated the job configuration.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Cannot find the object.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceScanLogs" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"appDate\": \"2020-05-05\", \"resourceName\": [ \"Oracle\" ]}"

Download the Resource Scan Logs for a Job

jobs/resourceScanLogs/{id}/result
API to download the resource scan logs for a job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceScanLogs/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/resourceScanLogs/4534/result" -H "accept: application/zip"

List the Job Details for Search Export Jobs

jobs/searchExports
API to list the jobs of search export type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the search export jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports?offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit the Job Configuration to Export Search Results

jobs/searchExports
API to submit the job configuration to the catalog for search results export task.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Required
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
attributeIds
Required
List comma-separated attributes to be exported.
String
Enter the IDs, separated by commas.
basicQuery
Optional
A query string. Uses blockjoin faceting to interpret the query. See Apache Lucene for more information.
String
-
fq
Optional
Filter queries to apply on the q parameter. Useful to apply facets.
Array [String]
-
q
Optional
Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query.
String
-
qf
Optional
Specifies the fields in the index to use in query. Enter index attributes that have index="true" in the view model.
String
-
relatedId
Optional
Specifies the object ID for which the related assets appear.
String
-
rootTo
Optional
Join results to resource or data set.
Choose one of the following parameters:
  • - RESOURCE
  • - DATA_SET
String
-
tabId
Optional
The tab ID to apply the filters.
String
-

Response Codes

Code
Reason
200
Bulk search export response.
201
Created
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"attributeIds\": [ \"string\" ], \"basicQuery\": \"string\", \"fq\": [ \"string\" ], \"q\": \"string\", \"qf\": [ \"string\" ], \"relatedId\": [ \"string\" ], \"rootTo\": \"RESOURCE\", \"tabId\":

List the Job Details for a Search Export Job

jobs/searchExports/{id}
API to list the job details about a search export job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the search export job.
Path
String

Response Codes

Code
Reason
200
Listed the job configuration.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports/87403" -H "accept: application/json"

Download the Results File for a Search Export Job

jobs/searchExports/{id}/result
API to download the CSV file that has the job details for a search export job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Download complete
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/searchExports/45643/result" -H "accept: application/excel"

List the Job Details for Service Log Jobs

jobs/serviceLogs
API to list the jobs of service log type and their job details.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/serviceLogs
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
jobId
Optional
Enter one or more job IDs to view the job details.
If you do not enter a job ID, the API uses the other configured parameters to filter and list the job IDs.
Query
Arrary [String]
offset
Optional
The offset position from which the API lists the jobs.
Default is 0.
Query
Integer
pageSize
Optional
The number of results to display in a page.
Default is 20.
Query
Integer
sortBy
Optional
Choose one of the following parameters to sort the jobs:
  • - CREATED_TIME
  • - STARTED_TIME
  • - END_TIME
Default is CREATED_TIME.
Query
String
sortOrder
Optional
Choose one of the following parameters to sort the jobs:
  • - DESC
  • - ASC
Default is DESC.
After the API sorts the job IDs based on sortBy parameter, it sorts the job IDs based on sortOrder parameter.
Query
String
jobStatus
Optional
Choose one of the following parameters to filter the jobs based on job status:
  • - RUNNING
  • - COMPLETED
  • - SUBMITTED
  • - FAILED
If you do not choose a job status, the API lists all the jobs.
Query
String

Response Codes

Code
Reason
200
Listed the jobs and job details.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/objectExports?jobId=694874&offset=0&pageSize=20&sortBy=CREATED_TIME&sortOrder=DESC" -H "accept: application/json"

Submit a Service Log Job

jobs/serviceLogs
API to submit a service log job to get the service logs.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/serviceLogs
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
config
Optional
Enter the required attributes.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
endDate
Optional
Enter the end date till which to list the service logs in the YYYY-MM-DD hh:mm:ss, YYYY-MM-DD hh:mm, or YYYY-MM-DD format.
String
-
serviceTypes
Optional
Enter comma-separated list of deployed services.
Arrary [String]
Enter one or more of the following services:
  • - HBASE
  • - SOLR
  • - INGESTION
  • - SERVICE
startDate
Optional
Enter the start date from which to list the service logs in the YYYY-MM-DD hh:mm:ss, YYYY-MM-DD hh:mm, or YYYY-MM-DD format.
String
-

Response Codes

Code
Reason
200
Submitted the job.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/serviceLogs" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"endDate\": \"YYYY-MM-DD hh:mm:ss\", \"serviceTypes\": [ \"HBASE\" ], \"startDate\": \"YYYY-MM-DD hh:mm:ss\"}"

Download the Service Logs for a Job

jobs/serviceLogs/{id}result
API to download the service logs for a job.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/jobs/serviceLogs/{id}/result
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the job.
Path
String

Response Codes

Code
Reason
200
Download complete.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/jobs/serviceLogs/23432/result" -H "accept: application/zip"