S3 jobs

Create a job

post

Creates a new job with the specified configuration.

Authorizations

Body

namestringRequiredExample: Test job

Responses

201

Job successfully created

application/json

jobIdstring · uuidOptionalExample: 0d842cd5-cbc1-4ab2-9943-f1307f214b14

post/job/create

POST /external-api/v1/job/create HTTP/1.1
Host: api.timetackle.com
Content-Type: application/json
Accept: */*
Content-Length: 632

{
  "name": "Test job",
  "config": {
    "teamId": 1234,
    "calendarIds": [
      "[e-mail]"
    ],
    "startDate": "2023-04-01",
    "endDate": "2023-09-30",
    "mergeAll": false,
    "filters": {
      "search": [
        "text"
      ],
      "tag": [
        "text"
      ],
      "allDay": "INCLUDE",
      "rsvp": false,
      "hasCrmAccount": true,
      "hasCrmOpportunity": true,
      "hasCrmOpportunityOwner": true,
      "hasCrmStage": true,
      "crmAccountTags": [
        "text"
      ],
      "crmOpportunityTags": [
        "text"
      ],
      "crmOpportunityOwnerTags": [
        "text"
      ],
      "crmStageTags": [
        "text"
      ],
      "taggedEvent": true
    },
    "formatting": {
      "date": "MM_DD_YYYY",
      "time": "HOUR_MIN_AMPM",
      "duration": "HOURS_IN_DECIMAL",
      "color": "NONE",
      "excludeOrganizer": false,
      "excludeResource": false,
      "singleColumnTag": false
    }
  }
}

201

Job successfully created

{
  "jobId": "0d842cd5-cbc1-4ab2-9943-f1307f214b14"
}

Get list of jobs

get

Retrieves a list of jobs with their details.

Authorizations

Responses

200

List of jobs

application/json

idintegerOptionalExample: 28

jobIdstring · uuidOptionalExample: 0d842cd5-cbc1-4ab2-9943-f1307f214b14

statusstring · enumOptionalExample: SUCCEEDPossible values:

namestringOptionalExample: Test job

executedAtstring · date-timeOptionalExample: 2023-07-03T06:54:28Z

lastModifiedAtstring · date-timeOptionalExample: 2023-07-03T06:54:39Z

get/job/list

GET /external-api/v1/job/list HTTP/1.1
Host: api.timetackle.com
Accept: */*

200

List of jobs

[
  {
    "id": 28,
    "jobId": "0d842cd5-cbc1-4ab2-9943-f1307f214b14",
    "status": "SUCCEED",
    "name": "Test job",
    "config": {
      "teamId": 1234,
      "calendarIds": [
        "[e-mail]"
      ],
      "startDate": "2023-04-01",
      "endDate": "2023-09-30",
      "mergeAll": false,
      "filters": {
        "search": [
          "text"
        ],
        "tag": [
          "text"
        ],
        "allDay": "INCLUDE",
        "rsvp": false,
        "hasCrmAccount": true,
        "hasCrmOpportunity": true,
        "hasCrmOpportunityOwner": true,
        "hasCrmStage": true,
        "crmAccountTags": [
          "text"
        ],
        "crmOpportunityTags": [
          "text"
        ],
        "crmOpportunityOwnerTags": [
          "text"
        ],
        "crmStageTags": [
          "text"
        ],
        "taggedEvent": true
      },
      "formatting": {
        "date": "MM_DD_YYYY",
        "time": "HOUR_MIN_AMPM",
        "duration": "HOURS_IN_DECIMAL",
        "color": "NONE",
        "excludeOrganizer": false,
        "excludeResource": false,
        "singleColumnTag": false
      }
    },
    "executedAt": "2023-07-03T06:54:28Z",
    "lastModifiedAt": "2023-07-03T06:54:39Z"
  }
]