Skip to main content
POST
/
schedulers
/
rules
Create a scheduler rule
curl --request POST \
  --url https://api.syntage.com/schedulers/rules \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "scheduler": "/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997",
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  },
  "cronExpression": "@daily"
}
'
{
  "@context": "/contexts/SchedulerRule",
  "@id": "/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "SchedulerRule",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "scheduler": "Daily Invoices Scheduler",
  "options": {
    "types": [
      "I",
      "E",
      "P"
    ],
    "period": {
      "from": "2020-01-01T00:00:00.000Z",
      "to": "2020-03-31T23:59:59.000Z"
    }
  },
  "cronExpression": "@daily",
  "nextRunDate": "2020-01-01T12:15:00.000Z",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Body

application/json
​
scheduler
string
required
write-only

Scheduler IRI reference

Example:

"/schedulers/91106968-1abd-4d64-85c1-4e73d96fb997"

​
extractor
enum<string>
required

Extractor to run, which retrieves resources from the corresponding datasource

Available options:
invoice,
monthly_tax_return,
annual_tax_return,
rif_tax_return,
tax_status,
tax_retention,
tax_compliance,
electronic_accounting,
sat_certificates,
rpc,
buro_de_credito_report,
bil,
rug
​
options
object

Extractor options; check the available options for each extractor in Extractions

Example:
{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}
​
cronExpression
string
write-only

Cron expression that controls when the rule runs

Example:

"@daily"

Response

Scheduler rule resource response

​
@context
string
default:/contexts/SchedulerRule
​
@id
string<iri-reference>

Scheduler Rule IRI reference

Example:

"/schedulers/rules/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:SchedulerRule

JSON-LD resource type

​
id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

​
scheduler
string

Scheduler that owns this rule

Example:

"Daily Invoices Scheduler"

​
extractor
enum<string>

Extractor to run, which retrieves resources from the corresponding datasource

Available options:
invoice,
monthly_tax_return,
annual_tax_return,
rif_tax_return,
tax_status,
tax_retention,
tax_compliance,
electronic_accounting,
sat_certificates,
rpc,
buro_de_credito_report,
bil,
rug
​
options
object

Extractor options; check the available options for each extractor in Extractions

Example:
{
  "types": ["I", "E", "P"],
  "period": {
    "from": "2020-01-01T00:00:00.000Z",
    "to": "2020-03-31T23:59:59.000Z"
  }
}
​
cronExpression
string | null

Cron expression that controls when the rule runs

Example:

"@daily"

​
nextRunDate
string

Date and time the resource should execute in the next iteration

Example:

"2020-01-01T12:15:00.000Z"

​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"