Enviar un Job de AppSail por ID

Descripción

Esta API te permite enviar un job a un Job Pool que activa el endpoint de un servicio AppSail.

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
{
"request_method": "get",
"source_type": "API",
"job_config": {
    "number_of_retries": "3",
    "retry_interval": 300
},
"job_name": "appsailJob",
"jobpool_id": "10108000002976201",
"target_type": "AppSail",
"target_id": "10108000002976191",
"url": "",
"headers": {
    "h1": "k1"
},
"params": {
    "p1": "v1"
}
}

View more

Alimentarás este JSON de solicitud en tu cuerpo de solicitud, 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 envío de 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 un fallo.

target_type String

mandatory

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

jobpool_id Numerical

mandatory

Contendrá el ID del Job Pool 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 del objetivo que el Job está destinado a activar. Por ejemplo, dado que este es un Job de AppSail, el ID del objetivo será el ID del servicio AppSail.

url String

optional

Contendrá la URL del servicio AppSail.

headers JSON

optional

Contendrá el valor de los encabezados que pasas al enviar el job.

params JSON

optional

Contendrá el valor de los parámetros que pasas al enviar el job.

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 ‘{“request_method”:“get”,“source_type”:“API”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:300},“job_name”:“appsailJob”,“jobpool_id”:“10108000002976201”,“target_type”:“AppSail”,“target_id”:“10108000002976191”,“url”:"",“headers”:{“h1”:“k1”},“params”:{“p1”:“v1”}}’

Sample Response
copy
{
"status": "success",
"data": {
    "job_id": "10108000004194320",
    "created_time": "Jun 05, 2024 05:02 PM",
    "response_code": null,
    "start_time": {},
    "end_time": {},
    "submitted_on": {
    "startTimeToRedirectLogsPage": "05/06/2024 16:57",
    "timeWithGivenTimezone": "Jun 05, 2024 05:02 PM IST",
    "timeWithJobTimezone": "Jun 05, 2024 05:02 PM IST"
    },
    "job_status": "PENDING",
    "capacity": {
    "number": "1"
    },
    "job_meta_details": {
    "id": "10108000004194321",
    "url": "",
    "job_name": "appsailJob",
    "job_config": {
        "number_of_retries": 3,
        "retry_interval": 300
    },
    "target_type": "AppSail",
    "target_details": {
        "id": "10108000002976191",
        "target_name": "appsailTrue"
    },
    "source_type": "API",
    "source_details": {
        "source_name": "API"
    },
    "jobpool_id": "10108000002976201",
    "jobpool_details": {
        "type": "AppSail",
        "name": "appsailJP",
        "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": "Mar 28, 2024 05:41 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": "Mar 28, 2024 05:41 PM",
        "project_details": {
        "project_name": "AppsailCron",
        "id": "10108000002976144",
        "project_type": "Live"
        },
        "id": "10108000002976201"
    },
    "headers": {
        "h1": "k1"
    },
    "params": {
        "p1": "v1"
    },
    "request_method": "get"
    },
    "retried_count": null,
    "parent_job_id": "10108000004194320",
    "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