Jump to

• Request
• Response

Read JobService

get

/jobService

Reads JobService objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<JobService>

Type: array

Title: List<JobService>

Show Source

• Array of: object JobService
  Title: JobService

  JobService Entity

{
    "title":"List<JobService>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/JobService"
    }
}

Nested Schema : JobService

Type: object

Title: JobService

JobService Entity

Show Source

• AddProjectInfo: string
• CopyOptions: string
• ExportFilePath: string
  Exported file path.
• ExportPlfFileNames: string
  File names of exported PLF files.
• ExportXMLByte: string
  Export byte array.
• FileName: string
  Exported File Name.
• ImportXMLByte: string
  Import byte array.
• JobData: string
  The job data for the job service.
• JobDataX: string
  The job data X for the job service.
• JobRecurringType: string
  JobRecurringType for job service
• JobStatus: string
  The status of the job.
• JobType: string
  The type of the job service.
• JobTypeKey: string
  Project ObjectId to be used by job.
• LastRunDate: string (date-time)
  LastRunDate for job service.
• Name: string
  The name of the job service.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PlfDirName: string
  PlfDirName
• ProjectInfo: string
• TargetWbsId: integer (int32)
• UserId: integer (int32)
  The ID of the user that ran a job service.

{
    "title":"JobService",
    "type":"object",
    "properties":{
        "AddProjectInfo":{
            "type":"string"
        },
        "CopyOptions":{
            "type":"string"
        },
        "ExportFilePath":{
            "type":"string",
            "description":"Exported file path."
        },
        "ExportPlfFileNames":{
            "type":"string",
            "description":"File names of exported PLF files."
        },
        "ExportXMLByte":{
            "type":"string",
            "description":"Export byte array."
        },
        "FileName":{
            "type":"string",
            "description":"Exported File Name."
        },
        "ImportXMLByte":{
            "type":"string",
            "description":"Import byte array."
        },
        "JobData":{
            "type":"string",
            "description":"The job data for the job service."
        },
        "JobDataX":{
            "type":"string",
            "description":"The job data X for the job service."
        },
        "JobRecurringType":{
            "type":"string",
            "description":"JobRecurringType for job service"
        },
        "JobStatus":{
            "type":"string",
            "description":"The status of the job."
        },
        "JobType":{
            "type":"string",
            "description":"The type of the job service."
        },
        "JobTypeKey":{
            "type":"string",
            "description":"Project ObjectId to be used by job."
        },
        "LastRunDate":{
            "type":"string",
            "description":"LastRunDate for job service.",
            "format":"date-time"
        },
        "Name":{
            "type":"string",
            "description":"The name of the job service."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PlfDirName":{
            "type":"string",
            "description":"PlfDirName"
        },
        "ProjectInfo":{
            "type":"string"
        },
        "TargetWbsId":{
            "type":"integer",
            "format":"int32"
        },
        "UserId":{
            "type":"integer",
            "description":"The ID of the user that ran a job service.",
            "format":"int32"
        }
    },
    "description":"JobService Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top