Job Actions
  • 03 Jun 2022
  • 1 Minute to read
  • Dark
    Light

Job Actions

  • Dark
    Light

Article Summary

getJob

Retrieves just one Job.

Property

Value

Description

id*

string

The ID of the Job

saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})

getAllJobs

Retrieves all Jobs.

Property

Value

Description

pageSize

integer

The page size (required for a paging request)

pageNum

integer

The page number (defaults to 1 for a paging request)

saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
getAllJobs()

saveJob

Updates a Job.

Property

Value

Description

id*

string

The ID of the Job

job = saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
job = getJob(job.id)

getJobRelationship

Retrieves just one Job Relationship.

Property

Value

Description

id*

string

The ID of the Job Relationship

job = saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
jobRel = saveJobRel({{"jobId": job.id, "userId":"user_id", "role": "ADMINISTRATOR"}
jobRel = getJobRelationship(jobRel.id)

getAllJobRelationships

Retrieves all Jobs Relationships.

Property

Value

Description

jobId

string

The job ID for which to fetch job relationships

userId

string

The user ID for which to fetch job relationships

role

string

The role for which to fetch job relationships

pageSize

integer

The page size (required for a paging request)

pageNum

integer

The page number (defaults to 1 for a paging request)

job = saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
jobRel = saveJobRel({{"jobId": job.id, "userId":"user_id", "role": "ADMINISTRATOR"}
jobRels = getAllJobRelationships()

saveJob

Updates a job.

Property

Value

Description

id*

string

The ID of the Job

job = saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
job = getJob(job.id)

saveJobRelationship

Updates a Job Relationship.

Property

Value

Description

id*

string

The ID of the Job Relationship

job = saveJob({"name": "math123", "code": "456", "title": "Best Math Teacher"})
jobRel = saveJobRel({{"jobId": job.id, "userId":"user_id", "role": "ADMINISTRATOR"}

deleteJobRelationship

Deletes a Job Relationship.

Property

Value

Description

id*

string

The ID of the Job Relationship

Delete by Job Relationship id.

deleteJob

Deletes a Job.

Property

Value

Description

id*

string

The ID of the Job

Delete by Job id.


Was this article helpful?