How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SERTICA Jobs API

The Jobs API from SERTICA — 61 operation(s) for jobs.

SERTICA Jobs API is one of 254 APIs that SERTICA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 68 operations across 61 paths, and defines 100 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /api.

68 operations 61 paths 100 schemas 4 DELETE28 GET33 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{sitename}.sertica.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

SERTICA Jobs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme

Paths & Operations 68

Across 61 paths, the API surfaces 68 operations — 4 DELETE, 28 GET, 33 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 68
GET
/Jobs
Gets a list of Jobs
GetJobs 2 params → 200401403500
POST
/Jobs
Creates a new job record
CreateJob body → 201400401403500
GET
/Jobs/search/{keyword}
Search jobs
SearchJobs 3 params → 200401403500
POST
/Jobs/search
Advanced search for jobs Takes a SearchDefinition input, which can include…
AdvancedSearchJobs 2 params body → 200401403500
POST
/Jobs/searchCount
Search for Jobs Takes a SearchDefinition input, which can include filters and…
SearchCountJobs body → 200401403500
POST
/Jobs/searchIndex/{jobGuid}
Get index of a record in a search for Jobs Takes a SearchDefinition input…
SearchIndexJobs 1 param body → 200401403500
GET
/Jobs/searchInfo
Returns structured information about what and how you can search for
JobSearchInfo → 200500
GET
/Jobs/{jobNo}
Gets a specific Job
GetJob 1 param → 200400404401403500
PUT
/Jobs/{jobNo}
Updates an existing Job
UpdateJob 1 param body → 200400401403500
DELETE
/Jobs/{jobNo}
Deletes a job record
deleteJobsByJobNo 1 param → 204400401403500
GET
/Jobs/{jobNo}/history
Gets history for a specific Job
GetHistoryForJob 3 params → 200400404401403500
GET
/Jobs/JobReports
Get job reports from user settings
GetJobReportsFromUserSettings 2 params → 400200404401403500
GET
/Jobs/{jobNos}/JobReports
Get job reports
GetJobReports 3 params → 400200404401403500
GET
/Jobs/{jobNo}/JobReport
Get job report
GetJobReport 3 params → 400200404401403500
POST
/Jobs/ActivateJobs
Activates all the jobs in the job list
ActivateJobs body → 200400401403500
POST
/Jobs/DeactivateJobs
Deactivates all the jobs in the job list
DeactivateJobs body → 200400401403500
POST
/Jobs/FinalizeJobs
Finalizes all the jobs in the job list
FinalizeJobs body → 200400401403500
DELETE
/Jobs/{jobNo}/force
Force deletes a job record Force deleting records may cause existing records to…
deleteJobsByJobNoForce 1 param → 204400401403500
GET
/Jobs/{jobNo}/resources
Fetches all Resources attached to the job
GetJobResources 1 param → 200401403500
GET
/Jobs/{jobNo}/items
Returns a list of Items used to perform the Job
GetJobItems 1 param → 200401403500
GET
/Jobs/{jobNo}/procedures
Returns a list of procedures used to perform the Job
GetJobProcedures 1 param → 200401403500
GET
/Jobs/{jobNo}/triggers
Returns a list of Items used to perform the Job
GetTriggers 1 param → 200401403500
POST
/triggers/longDescription
Returns a specific job trigger
GetTriggerLongDescription body → 200404401403500
GET
/Jobs/{jobNo}/documents
Returns a list of Documents used on the Job
GetJobDocuments 1 param → 200401403500
GET
/Jobs/{jobNo}/jobgroups
Fetches all JobGroups attached to the job
GetJobJobGroups 1 param → 200401403500
GET
/Jobs/{jobNo}/notifications
Fetches all Notifications attached to the job
GetJobNotifications 1 param → 200401403500
GET
/Jobs/{jobNo}/formTemplates
Fetches all FormTemplates attached to the job
GetJobFormTemplates 1 param → 200401403500
POST
/Jobs/{jobNo}/formTemplates/createForm
Creates a Form based on the supplied JobFormTemplate object
CreateJobFormTemplateForm 1 param body → 200401403500
GET
/Jobs/{jobNo}/copy
Copies an existing Job to a new object
CopyJob 1 param → 200400401403500
POST
/Jobs/finalizerunoncejob
Creates a new run once job record with a finalized job history
FinalizeRunOnceJob body → 201400401403500
POST
/jobs/{jobNo}/sendtoemail
Send job to supplier
SendToEmail 1 param body → 400401403500
GET
/Jobs/{jobNo}/jobmailattachments
Gets usages for a specific Document
GetAttachmentsFor 1 param → 200400404401403500
POST
/jobs/{jobNo}/postpone
Postpone a Job
JobPostpone 1 param body → 400401403500
POST
/jobs/{jobNo}/approvepostpone
Approve Postponement of a Job
JobApprovePostpone 1 param body → 400401403500
POST
/jobs/{jobNo}/rejectpostpone
Reject Postponement of a Job
JobRejectPostpone 1 param body → 400401403500
POST
/jobs/{jobNo}/move
Move a Job to another component
JobMove 1 param body → 200400401403500
POST
/Jobs/appRequest
Get Job Lists for App
JobAppRequest → 200401403500
POST
/Jobs/appRequest/checksum
Get checksum of Job Lists for App
JobAppRequestChecksum → 200401403500
POST
/Jobs/appSubmit
Receive a new Job from new Job App or updates GPS on an existing Job
ReceiveJob body → 200400401403500
GET
/Jobs/{jobNo}/relatedjobs
Returns an ordered list of related Jobs
GetRelatedJobs 1 param → 200401403500
GET
/Jobs/appRequest/showJobsOnMapTemplate
Returns a string with the HTML of the template used to show Jobs on a map
JobAppRequestShowJobsOnMapTemplate → 200401403500
GET
/Jobs/{jobNo}/documents/{documentNo}/pdf
Get document pdf for job
GetDocumentPdfForJob 2 params → 400401403500
GET
/Jobs/{jobNo}/documents/{documentNo}/file
Get document file for job
GetDocumentFileForJob 3 params → 400401403500
GET
/Jobs/{jobNo}/assignees
Fetches all Assigned to current instance of job
GetAssignees 1 param → 200401403500
POST
/Jobs/assignees
Gets all assignees for all job instances
GetAllAssignees body → 200401403500
PUT
/Jobs/assignees
Update assignees
UpdateAssignees body → 200400401403500
POST
/Jobs/resource/{resourceNo}/assignees
Fetches all Resource Assignees
GetResourceAssignees 1 param body → 200401403500
GET
/Jobs/propertyDefinitions
Get a list of PropertyDefinitions
GetJobPropertyDefinitions → 200401500
POST
/Jobs/propertyDefinitions
Creates a new PropertyDefinition record
CreateJobPropertyDefinition body → 201400401403500
GET
/Jobs/propertyDefinitions/{propertyDefinitionGuid}
Gets a specific PropertyDefinition
GetJobPropertyDefinition 1 param → 200400404401500
PUT
/Jobs/propertyDefinitions/{propertyDefinitionGuid}
Updates an existing PropertyDefinition
UpdateJobPropertyDefinition 1 param body → 200400401403500
DELETE
/Jobs/propertyDefinitions/{propertyDefinitionGuid}
Deletes a PropertyDefinition record
DeleteJobPropertyDefinition 1 param → 200401403500
GET
/Jobs/propertyDefinitions/{propertyDefinitionGuid}/listValues
Returns a list of values for a PropertyDefinition
GetJobPropertyDefinitionListValues 2 params → 200401500
DELETE
/Jobs/propertyDefinitions/{propertyDefinitionGuid}/force
Force Deletes a PropertyDefinition record
ForceDeleteJobPropertyDefinition 1 param → 200401403500
GET
/Jobs/propertyDefinitions/{propertyName}/available
Lookup if PropertyName of a PropertyDefinition is not already in use and…
JobPropertyNameAvailable 1 param → 200401500
POST
/Jobs/screenLayout
Bulk updates screenlayout and a list of Property Definitions.
BulkUpdateJobScreenLayout body → 201400401403500
GET
/Jobs/{jobNo}/managementSystemDocuments/preview
Returns a combined preview of the Management System Documents selected for…
GetManagementSystemDocumentsPreview 1 param → 400401403500
POST
/Jobs/BatchEdit
Job batch edit
JobBatchEdit body → 200400401403500
POST
/Jobs/BatchEdit/ApplyTransformations/{jobNo}
Job batch edit apply transformations
JobBatchEditApplyTransformations 1 param body → 200400401403500
POST
/Jobs/{jobNo}/webhooklogs/search
Searches the Webhooks associated with the Job
SearchJobWebhookLogs 3 params body → 200401403500
POST
/Jobs/{jobNo}/webhooklogs/searchCount
Returns number of hits in a search for the Job's Webhook Logs.
SearchJobWebhookLogsCount 1 param body → 200401403500
POST
/Jobs/{jobNo}/webhooklogs/{webhookLogGuid}/retransmit
Retransmits a specific Webhook based on the selected Webhook Log
RetransmitJobWebhookLog 2 params → 200401403500
POST
/Jobs/{jobNo}/webhooklogs/{webhookLogGuid}/resolve
Resolves a specific Webhook Log with a Response Log entry
ResolveJobWebhookLog 2 params body → 200401403500
POST
/Jobs/{jobNo}/markasread
Mark as read
MarkAsRead 1 param → 200401403500
POST
/Jobs/{jobNo}/markasunread
Mark as unread
MarkAsUnread 1 param → 200401403500
POST
/Jobs/{jobNo}/acknowledge
Acknowledge
Acknowledge 1 param → 200401403500
POST
/Jobs/{jobNo}/disable
Disable the job for the provided jobNo
DisableJob 1 param body → 200400401403500
POST
/Jobs/{jobNo}/enable
Enables the job for the provided jobNo
EnableJob 1 param body → 200400401403500

Schemas 100

The contract defines 100 schemas that model the data the API accepts and returns. The most detailed are SerticaWebApi.Models.Job.Job (129 properties), SerticaWebApi.Models.Job.JobTrigger (64 properties), Logihold.BusinessObjects.Apps.Models.JobAppObject (46 properties), SerticaWebApi.Models.CustomProperties.PropertyDefinition (31 properties). Each schema is shown below with its type and property counts.

Logihold.BusinessObjects.Apps.Models.JobHistoryPictureAppObject
object
14 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType
string
SerticaWebApi.Models.Job.JobActivationMessage
object
5 properties
SerticaWebApi.Models.Job.RecurrenceType
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo
object
2 properties
SerticaWebApi.Models.ErrorReason
object
2 properties
SerticaWebApi.Models.Link
object
2 properties
SerticaWebApi.Models.Job.OrdinalNumbers
string
SerticaWebApi.Models.Document.FileContentDisposition
string
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssueReason
string
SerticaWebApi.Models.Job.PlanningType
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat
string
Logihold.BusinessObjects.Apps.Models.JobManagementSystemDocumentAppObject
object
13 properties
SerticaWebApi.Models.Job.JobMoveInfo
object
1 property
SerticaWebApi.Models.Framework.Amount
object
3 properties
SerticaWebApi.Models.Job.JobPlanningUpdateResult
object
2 properties
SerticaWebApi.Models.Job.Months
string
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.JobMailAttachmentView
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition
object
8 properties
SerticaWebApi.Models.Job.JobFormTemplate
object
20 properties
SerticaWebApi.Models.Job.JobJobGroup
object
12 properties
SerticaWebApi.Models.Job.MeasureTriggerType
string
SerticaWebApi.Models.CustomProperties.PropertyDefinition
object
31 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_JobFormTemplateDefaultAction
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_FormStatus
string
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDeactivationIssue
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssueReason
string
SerticaWebApi.Models.Job.JobNotification
object
13 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_TriggerType
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_DocumentType
string
Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching
string
Logihold.BusinessObjects.Apps.Models.JobJobGroupAppObject
object
13 properties
SerticaWebApi.Models.Job.JobDeactivationMessage
object
4 properties
Logihold.BusinessObjects.Apps.Models.JobGroupFormTemplateAppObject
object
13 properties
SerticaWebApi.Models.Job.JobDisableResult
object
2 properties
SerticaWebApi.Models.ApiMailAttachment
object
3 properties
Logihold.BusinessObjects.Apps.Models.JobResourceAppObject
object
11 properties
SerticaWebApi.Models.BatchEdit.BatchEditApplyTransformations
object
2 properties
SerticaWebApi.Models.Job.Job
object
129 properties
SerticaWebApi.Models.BrokenRule
object
7 properties
SerticaWebApi.Models.Webhooks.WebhookLog
object
20 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableArguments
object
1 property
Logimatic.BaseClasses30.DataOwner
string
SerticaWebApi.Models.BrokenRuleType
string
Logihold.BusinessObjects.LogiholdObjModel.JobNotificationDaysDirection
string
SerticaWebApi.Models.Job.JobDeactivationResult
object
2 properties
SerticaWebApi.Models.BatchEdit.BatchEditOperation
string
SerticaWebApi.Models.BatchEdit.BatchEditResultState
string
SerticaWebApi.Models.BatchEdit.BatchEditResult
object
1 property
SerticaWebApi.Models.Job.TriggerType
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_JobInstancePostponementStatus
string
SerticaWebApi.Models.CustomProperties.PropertyDefinitionUnitDependency
object
11 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionFieldDependency
object
13 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssueReason
string
SerticaWebApi.Models.Job.JobFinalizationResult
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_FormTemplateFormEditor
string
Logihold.BusinessObjects.Apps.Models.JobHistoryAppObject
object
19 properties
SerticaWebApi.Models.Job.JobMail
object
7 properties
SerticaWebApi.Models.CustomProperties.PropertyDefinitionListValue
object
9 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobActivationIssue
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssueReason
string
SerticaWebApi.Models.Job.JobActivationResult
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_WebhookLogStatus
string
Logihold.BusinessObjects.Apps.Models.JobExpectedFaultAppObject
object
9 properties
Logihold.BusinessObjects.Apps.Models.JobAppObject
object
46 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobFinalizationIssue
object
2 properties
SerticaWebApi.Models.BatchEdit.BatchEditTransformation
object
8 properties
Logihold.BusinessObjects.Apps.Models.JobProcedureAppObject
object
10 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator
string
SerticaWebApi.Models.CustomLayout.ScreenLayout
object
8 properties
Logihold.BusinessObjects.Apps.Models.DocumentLinkAppObject
object
13 properties
Logihold.BusinessObjects.Apps.Models.JobListAppObject
object
8 properties
SerticaWebApi.Models.Job.JobDocument
object
25 properties
Logihold.BusinessObjects.Apps.Models.JobHistoryResourceAppObject
object
15 properties
SerticaWebApi.Models.Job.JobPostponementInfo
object
4 properties
SerticaWebApi.Models.Job.JobItem
object
25 properties
Logihold.BusinessObjects.LogiholdObjModel.CustomProperties.PropertyDataType
string
SerticaWebApi.Models.BatchEdit.BatchEdit
object
4 properties
Logihold.BusinessObjects.Apps.Models.JobHistoryResponseAppObject
object
12 properties
Logihold.BusinessObjects.Apps.Models.JobItemAppObject
object
16 properties
SerticaWebApi.Models.ValidationResult
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField
object
5 properties
SerticaWebApi.Models.Job.JobFinalizationMessage
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_ExternalDocmentationSource
string
SerticaWebApi.Models.BatchEdit.BatchEditRecordResult
object
3 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_DataObject
string
Logihold.BusinessObjects.Apps.Models.JobFormTemplateAppObject
object
19 properties
SerticaWebApi.Models.Job.JobResource
object
16 properties
SerticaWebApi.Models.Job.JobAssignee
object
29 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_JobHistoryStatus
string
Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy
object
2 properties
SerticaWebApi.Models.Job.JobProcedure
object
14 properties
Logihold.BusinessObjects.LogiholdObjModel.Maintenance.Planning.JobDisableIssue
object
2 properties
SerticaWebApi.Models.Job.JobTrigger
object
64 properties
Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection
string
Logihold.BusinessObjects.Apps.Models.JobHistoryItemAppObject
object
18 properties
SerticaWebApi.Models.CustomLayout.ScreenLayoutBulkUpdate
object
2 properties
SerticaWebApi.Models.Job.JobDisablerMessage
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sertica-jobs-api-openapi.yml Raw ↑

Other APIs SERTICA publishes across the network.

SERTICA Accounting Dimensions API
SERTICA Accounting Dimensions Cache API
SERTICA Accounts API
SERTICA Activity Groups API
SERTICA Address Categories API
SERTICA Address Classifications API
SERTICA Addresses API
SERTICA AI Client API
SERTICA Analytics API
SERTICA Analytics Custom Menus API
SERTICA Analytics Custom Templates API
SERTICA Analytics Excel Templates API
Where this information came from

This is an independent, third-party profile of SERTICA Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.