Create Job

Request

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Content-Type

string

required

application/json

Body Params application/json

Name

string

required

SalesRepresentative

integer

optional

ProjectManager

integer

optional

ProjectManagerAlt

integer

optional

ReferenceNumber

string

optional

Maximum Length can be 100 chars

Status

integer

required

Example 0/1/2

Description

string

optional

Category

integer

required

It can be a Number from 1 to 43

isEncryptionAdded

integer

optional

Values can be 0 or 1

FingerPrintingLevel

integer

optional

Values can be 1, 2, 3 or 4(If we pass ‘FingerPrintingLevel’ as 4 then 'selectedJobsId’ Fields will be mandatory)

selectedJobsId

array[integer]

optional

Array of JobIds like [11048, 11049]

AllowDuplicateStatus

array[integer]

optional

Array of Numbers like [1, 2, 3, 4]

StartDate

string

optional

ISO String format

EndDate

string

optional

ISO String format

ProjectedCloseDate

object

optional

Year

integer

optional

YYYY format

Month

integer

optional

MM format

DigitalFingerprintType

integer

optional

Value should be 3

UniqueIPCheck

integer

optional

Used as boolean 0 for false and 1 for true

UniquePIDCheck

integer

optional

Used as boolean 0 for false and 1 for true

Example

{
    "Name": "Sample Project",
    "SalesRepresentative": 12345,
    "ProjectManager": 67890,
    "ProjectManagerAlt": 11223,
    "ReferenceNumber": "REF-20250303-001",
    "Status": 1,
    "Description": "This is a sample project description.",
    "Category": 5,
    "isEncryptionAdded": 1,
    "FingerPrintingLevel": 3,
    "selectedJobsId": [
        11048,
        11049
    ],
    "AllowDuplicateStatus": [
        1,
        2,
        3,
        4
    ],
    "StartDate": "2025-03-03T00:00:00.000Z",
    "EndDate": "2025-06-03T00:00:00.000Z",
    "ProjectedCloseDate": {
        "Year": 2025,
        "Month": 6
    },
    "DigitalFingerprintType": 3,
    "UniqueIPCheck": 1,
    "UniquePIDCheck": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apivisionsampling.innovatemr.com/api/v2/pega/job' \
--header 'x-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Name": "Sample Project",
    "SalesRepresentative": 12345,
    "ProjectManager": 67890,
    "ProjectManagerAlt": 11223,
    "ReferenceNumber": "REF-20250303-001",
    "Status": 1,
    "Description": "This is a sample project description.",
    "Category": 5,
    "isEncryptionAdded": 1,
    "FingerPrintingLevel": 3,
    "selectedJobsId": [
        11048,
        11049
    ],
    "AllowDuplicateStatus": [
        1,
        2,
        3,
        4
    ],
    "StartDate": "2025-03-03T00:00:00.000Z",
    "EndDate": "2025-06-03T00:00:00.000Z",
    "ProjectedCloseDate": {
        "Year": 2025,
        "Month": 6
    },
    "DigitalFingerprintType": 3,
    "UniqueIPCheck": 1,
    "UniquePIDCheck": 0
}'

Responses

🟢200OK

application/json

Body

apiStatus

string

required

msg

string

required

job

object

required

Customer

object

required

ProjectManager

object

required

ProjectedCloseDate

object

required

Status

integer

required

FingerPrintingLevel

integer

required

AllowDuplicateStatus

array[string]

required

Name

string

required

Category

integer

required

isEncryptionAdded

integer

required

DigitalFingerprintType

integer

required

CustomerContact

array [object {3}]

required

StartDate

string

required

EndDate

string

required

LiveDate

string

required

Id

integer

required

Success

string

required

Termination

string

required

Over Quota

string

required

Quality Termination

string

required

result

object

required

status

string

required

disqualification

string

required

Example

{
    "apiStatus": "success",
    "msg": "Job is successfully added",
    "job": {
        "Customer": {
            "CustomerName": "customer_demo",
            "CustomerId": 389
        },
        "ProjectManager": {
            "ProjectManagerName": "pm1",
            "ProjectManagerId": 67
        },
        "ProjectedCloseDate": {
            "Month": 1,
            "Year": 2019
        },
        "Status": 1,
        "FingerPrintingLevel": 2,
        "AllowDuplicateStatus": [],
        "Name": "Job for Group Main",
        "Category": 1,
        "isEncryptionAdded": 0,
        "DigitalFingerprintType": 3,
        "CustomerContact": [
            {
                "Primary": 0,
                "CustomerContactId": 671,
                "CustomerContactName": "DemoCustomer"
            }
        ],
        "StartDate": "2019-01-02T11:04:34.662Z",
        "EndDate": "2019-01-02T11:04:34.663Z",
        "LiveDate": "2019-01-02T11:04:34.663Z",
        "Id": 8535,
        "Success": "https://apivisionsampling.innovatemr.com/surveyDone?sc=1&tk=",
        "Termination": "https://apivisionsampling.innovatemr.com/surveyDone?sc=2&tk=",
        "Over Quota": "https://apivisionsampling.innovatemr.com/surveyDone?sc=3&tk=",
        "Quality Termination": "https://apivisionsampling.innovatemr.com/surveyDone?sc=4&tk="
    }
}