Crear un Cron diario

Descripción

Esta API te permite crear un cron de tipo recurrente diario que en el momento programado envía un Job al Job Pool y activa un endpoint de Job Function.

Nota:

En esta API, estamos ilustrando la solicitud de ejemplo y la respuesta de ejemplo con una Job Function. La funcionalidad de la API sigue siendo la misma para webhook, Circuits y jobs de AppSail.
Esta API es aplicable para Crons predefinidos y Crons dinámicos.

Detalles de la solicitud

URL de solicitud

POST

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

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.cron.CREATE

JSON de solicitud

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

Sample Payload
copy
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
    "repetition_type": "daily",
    "hour": "1",
    "minute": "0",
    "second": "0",
    "timezone": "PST"
},
"job_meta": {
    "source_type": "Cron",
    "job_config": {
    "number_of_retries": "1",
    "retry_interval": "300"
    },
    "job_name": "job",
    "jobpool_id": "10108000003823563",
    "target_type": "Function",
    "target_id": "10108000003823893",
    "params": {
    "param1": "value1"
    }
},
"cron_name": "RecursiveCronDaily",
"end_time": 1718002799,
"description": "dailycron",
"cron_execution_type": "pre-defined"
}

View more

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

cron_type String

mandatory

Indicará el tipo de programación del cron

cron_status Boolean

mandatory

Indicará si el cron está habilitado o deshabilitado.

job_detail JSON

mandatory

Contendrá los detalles del job que está siendo enviado por el cron.

job_meta JSON

mandatory

Contendrá la meta información sobre el job que está siendo enviado por el cron.

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_type String

mandatory

Indicará qué endpoint de tipo destino se va a activar. Puede ser Function, Webhook, Circuit o AppSail.

target_id Numerical

mandatory

Contendrá el ID único con el cual se referenciará el tipo de destino.

params JSON

mandatory

Contendrá el valor de los headers y params que pasas al enviar el job.

cron_name String

mandatory

Contendrá el nombre del cron que vas a crear.

cron_execution_type String

mandatory

Indicará si es un cron pre-defined o dynamic.

Detalles de la respuesta

La respuesta JSON devuelve los metadatos del cron creado. La respuesta también contendrá los detalles del usuario que creó el cron.

Sample Request
copy

curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“daily”,“hour”:“1”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“300”},“job_name”:“job”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“RecursiveCronDaily”,“end_time”:1718002799,“description”:“dailycron”,“cron_execution_type”:“pre-defined”}’

Sample Response
copy
{
"status": "success",
"data": {
    "cron_name": "RecursiveCronDaily",
    "description": "dailycron",
    "cron_type": "Calendar",
    "cron_execution_type": "pre-defined",
    "job_meta": {
    "id": "10108000004280518",
    "url": "",
    "job_name": "job",
    "job_config": {
        "number_of_retries": 1,
        "retry_interval": 300
    },
    "target_type": "Function",
    "target_details": {
        "id": "10108000003823893",
        "target_name": "target_function_fetch"
    },
    "source_type": "Cron",
    "source_details": {
        "id": "10108000004280516",
        "source_name": "RecursiveCronDaily",
        "details": {
        "cron_execution_type": "pre-defined"
        }
    },
    "jobpool_id": "10108000003823563",
    "jobpool_details": {
        "type": "Function",
        "name": "VendorReminder",
        "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:44 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:44 PM",
        "capacity": {
        "memory": "2048"
        },
        "project_details": {
        "project_name": "ZylkerShipments",
        "id": "10108000003823392",
        "project_type": "Live"
        },
        "id": "10108000003823563"
    },
    "headers": {},
    "params": {
        "param1": "value1"
    }
    },
    "cron_status": true,
    "created_time": "Jun 07, 2024 12:33 PM",
    "created_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": "Jun 07, 2024 12:33 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"
    },
    "project_details": {
    "project_name": "ZylkerShipments",
    "id": "10108000003823392",
    "project_type": "Live"
    },
    "end_time": "1718002799",
    "cron_detail": {
    "jobId": "10108000004280516",
    "transactionTimeout": -1,
    "hour": 1,
    "minute": 0,
    "second": 0,
    "repetition_type": "daily",
    "timezone": "PST"
    },
    "id": "10108000004280516"
}
}

View more

Create a Recurring Cron- Java SDK

Create a Recurring Cron- Node.js SDK

Create a Recurring Cron- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit