Jump to

• Request
• Response

Initiate a Gateway Job with a Parameter (Deprecated since 24.2)

post

/api/restapi/pims/services/createJobProcessWithParameters/{id}

Send a request to this endpoint to start a Gateway synchronization job.

Request

Path Parameters

• id(required): integer(int64)
  The system-generated identifier of a job.

  Default Value: 1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "exampleSetFlag":false,
    "types":[
        "object"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : schema

Type: boolean

404 Response

Unable to create the Gateway job using the provided request data.

Back to Top