Jump to

• Request
• Response

Update Background Job Configuration

post

/services/private/processes/update/process_config/execution

This service is used to update the configuration for each background jobs .

Request

Header Parameters

• Accept-Language:
  Accept-Language header

  Example:

  en-US

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: array

Show Source

• Array of: object B8dProcessConfig

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/B8dProcessConfig"
    }
}

Nested Schema : B8dProcessConfig

Type: object

Show Source

• archiveInd: string
• commitMaxCounter: integer (int64)
• enableInd: string
• jobName: string
• jobPriority: integer (int64)
• numDataToProcess: integer (int64)
• numThreads: integer (int64)

{
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string"
        },
        "numThreads":{
            "type":"integer",
            "format":"int64"
        },
        "numDataToProcess":{
            "type":"integer",
            "format":"int64"
        },
        "commitMaxCounter":{
            "type":"integer",
            "format":"int64"
        },
        "jobPriority":{
            "type":"integer",
            "format":"int64"
        },
        "enableInd":{
            "type":"string"
        },
        "archiveInd":{
            "type":"string"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object B8dProcessConfig

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/B8dProcessConfig"
    }
}

Nested Schema : B8dProcessConfig

Type: object

Show Source

• archiveInd: string
• commitMaxCounter: integer (int64)
• enableInd: string
• jobName: string
• jobPriority: integer (int64)
• numDataToProcess: integer (int64)
• numThreads: integer (int64)

{
    "type":"object",
    "properties":{
        "jobName":{
            "type":"string"
        },
        "numThreads":{
            "type":"integer",
            "format":"int64"
        },
        "numDataToProcess":{
            "type":"integer",
            "format":"int64"
        },
        "commitMaxCounter":{
            "type":"integer",
            "format":"int64"
        },
        "jobPriority":{
            "type":"integer",
            "format":"int64"
        },
        "enableInd":{
            "type":"string"
        },
        "archiveInd":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Background jobs Configuration

Body ()

Root Schema : BatchJobRunStatusRDO

Type: object

Show Source

• attributeNames: array attributeNames
• attributes: array attributes
• hyperMediaContent: object hyperMediaContent
• jobId: string
• jsonFieldNameMap: object jsonFieldNameMap
  Additional Properties Allowed: additionalProperties
• links: array links
• status: string
• statusMessage: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "attributeNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "jsonFieldNameMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "statusMessage":{
            "type":"string"
        },
        "hyperMediaContent":{
            "type":"object"
        }
    }
}

Nested Schema : attributeNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : attributes

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : hyperMediaContent

Type: object

Nested Schema : jsonFieldNameMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : items

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Back to Top