Enviar un Circuit Job por ID

Descripción

Esta API te permite enviar un job a un Job Pool que activa un endpoint de Circuit.

Detalles de la Solicitud

URL de Solicitud

POST

{api-domain}/baas/v1/project/{project_id}/job_scheduling/job

copy

project_id

Numerical

El ID único del proyecto

Encabezados de Solicitud

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

Encabezados Opcionales

CATALYST-ORG: {org_id}

Environment: Development

Alcance

ZohoCatalyst.job.CREATE

JSON de Solicitud

Debes enviar un JSON con sus valores correspondientes como se muestra a continuación.

Sample Payload
copy
{
"source_type": "API",
"job_config": {
    "number_of_retries": "4",
    "retry_interval": 300
},
"job_name": "circuitJob",
"jobpool_id": "10108000003823699",
"target_type": "Circuit",
"target_id": "10108000004194246",
"test_cases": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
}
}

View more

Alimentarás este JSON de solicitud en tu Request Body, y necesitas proporcionar el valor de:

request_method

mandatory

Indica el método de solicitud con el que se activará el webhook, y los valores pueden ser get, post, put, delete, head o patch.

source_type

mandatory

Siempre contendrá API como su valor para la API de submit job.

job_config JSON

mandatory

Contendrá los pares clave-valor number_of_retries y retry_interval. Esto determinará la acción de reintento en caso de fallo.

target_type String

mandatory

Indicará qué tipo de destino está destinado a activar el job.

jobpool_id Numerical

mandatory

Contendrá el Job Pool ID del job pool que ejecutará el job.

job_name String

mandatory

Contendrá el nombre del job que necesitas activar.

target_id Number

mandatory

Contendrá el ID único del Circuit que el job está destinado a activar.

test_cases JSON

optional

Contendrá la entrada de pares clave-valor JSON que necesitas alimentar al Circuit.

Detalles de la Respuesta

La respuesta JSON devuelve los metadatos del job enviado. La respuesta también contendrá los detalles del usuario que envió el job.

Sample Request
copy

curl -X POST 

https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“4”,“retry_interval”:300},“job_name”:“circuitJob”,“jobpool_id”:“10108000003823699”,“target_type”:“Circuit”,“target_id”:“10108000004194246”,“test_cases”:{“key1”:“value1”,“key2”:“value2”,“key3”:“value3”}}’

Sample Response
copy
{
"status": "success",
"data": {
    "job_id": "10108000004194251",
    "created_time": "Jun 05, 2024 04:56 PM",
    "response_code": null,
    "start_time": {},
    "end_time": {},
    "submitted_on": {
    "startTimeToRedirectLogsPage": "05/06/2024 16:51",
    "timeWithGivenTimezone": "Jun 05, 2024 04:56 PM IST",
    "timeWithJobTimezone": "Jun 05, 2024 04:56 PM IST"
    },
    "job_status": "PENDING",
    "capacity": {
    "number": "1"
    },
    "job_meta_details": {
    "id": "10108000004194252",
    "job_name": "circuitJob",
    "job_config": {
        "number_of_retries": 4,
        "retry_interval": 300
    },
    "target_type": "Circuit",
    "target_details": {
        "id": "10108000004194246",
        "target_name": "abc"
    },
    "source_type": "API",
    "source_details": {
        "source_name": "API"
    },
    "jobpool_id": "10108000003823699",
    "jobpool_details": {
        "type": "Circuit",
        "name": "InventoryDataMaintaince",
        "created_by": {
        "zuid": "77941453",
        "is_confirmed": false,
        "email_id": "emmy@zylker.com",
        "first_name": "Amelia Burrows",
        "last_name": "",
        "user_type": "Admin",
        "user_id": "10108000000009004"
        },
        "created_time": "May 28, 2024 04:49 PM",
        "modified_by": {
        "zuid": "77941453",
        "is_confirmed": false,
        "email_id": "emmy@zylker.com",
        "first_name": "Amelia Burrows",
        "last_name": "",
        "user_type": "Admin",
        "user_id": "10108000000009004"
        },
        "modified_time": "May 28, 2024 04:49 PM",
        "project_details": {
        "project_name": "ZylkerShipments",
        "id": "10108000003823392",
        "project_type": "Live"
        },
        "id": "10108000003823699"
    },
    "headers": {},
    "params": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
    },
    "retried_count": null,
    "parent_job_id": "10108000004194251",
    "execution_time": null
}
}

View more

Create Job- Java SDK

Create Job- Node.js SDK

Create Job- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit