Change Manager (v1.0)

http://localhost

Table of contents

Change Manager API

API for accessing ChangeManager's bussiness logic

/change-manager

POST /change-manager/jobExecutions

Initialize JobExecutions

POST /change-manager/jobExecutions
Body

Media type: application/json

Response 201

Body

Media type: application/json

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

PUT /change-manager/jobExecution/{id}

Update JobExecution

PUT /change-manager/jobExecution/{id}
URI Parameters
  • id: required (string)
Body

Media type: application/json

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job Execution Schema",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier",
      "type": "string"
    },
    "hrId": {
      "description": "Human readable id",
      "type": "string"
    },
    "parentJobId": {
      "description": "Id of the parent JobExecution entity",
      "type": "string"
    },
    "subordinationType": {
      "description": "Type of subordination to another JobExecution entities",
      "type": "string",
      "enum": ["CHILD", "PARENT_SINGLE", "PARENT_MULTIPLE"]
    },
    "jobProfileName": {
      "description": "Name of the related JobProfile",
      "type": "string"
    },
    "sourcePath": {
      "description": "Path to the file",
      "type": "string"
    },
    "runBy": {
      "description": "First and last name of the user that triggered the job execution",
      "type": "object",
      "properties": {
        "firstName": {
          "description": "First name",
          "type": "string"
        },
        "lastName": {
          "description": "Last name",
          "type": "string"
        }
      }
    },
    "progress": {
      "description": "Execution progress of the job",
      "type": "object",
      "properties": {
        "current": {
          "description": "Currently processing record",
          "type": "integer"
        },
        "total": {
          "description": "Total number of records to be processed",
          "type": "integer"
        }
      }
    },
    "startedDate": {
      "description": "Date and time when the job execution started",
      "type": "string",
      "format": "date-time"
    },
    "completedDate": {
      "description": "Date and time when the job execution completed",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Current status of the job execution",
      "type": "string",
      "$ref": "status.json"
    },
    "uiStatus": {
      "description": "Status that is rendered on UI",
      "type": "string",
      "$ref": "uiStatus.json"
    },
    "errorStatus": {
      "description": "Status that describe error state of job execution",
      "type": "string",
      "$ref": "errorStatus.json"
    },
    "userId": {
      "description": "ID of the user who created the JobExecution",
      "type": "string"
    }
  },
  "required": [
    "id",
    "parentJobId",
    "subordinationType",
    "status",
    "uiStatus",
    "userId"
  ]
}

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 422

Unprocessable Entity

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

GET /change-manager/jobExecution/{id}

Get JobExecution by id

GET /change-manager/jobExecution/{id}
URI Parameters
  • id: required (string)

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Job Execution Schema",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier",
      "type": "string"
    },
    "hrId": {
      "description": "Human readable id",
      "type": "string"
    },
    "parentJobId": {
      "description": "Id of the parent JobExecution entity",
      "type": "string"
    },
    "subordinationType": {
      "description": "Type of subordination to another JobExecution entities",
      "type": "string",
      "enum": ["CHILD", "PARENT_SINGLE", "PARENT_MULTIPLE"]
    },
    "jobProfileName": {
      "description": "Name of the related JobProfile",
      "type": "string"
    },
    "sourcePath": {
      "description": "Path to the file",
      "type": "string"
    },
    "runBy": {
      "description": "First and last name of the user that triggered the job execution",
      "type": "object",
      "properties": {
        "firstName": {
          "description": "First name",
          "type": "string"
        },
        "lastName": {
          "description": "Last name",
          "type": "string"
        }
      }
    },
    "progress": {
      "description": "Execution progress of the job",
      "type": "object",
      "properties": {
        "current": {
          "description": "Currently processing record",
          "type": "integer"
        },
        "total": {
          "description": "Total number of records to be processed",
          "type": "integer"
        }
      }
    },
    "startedDate": {
      "description": "Date and time when the job execution started",
      "type": "string",
      "format": "date-time"
    },
    "completedDate": {
      "description": "Date and time when the job execution completed",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Current status of the job execution",
      "type": "string",
      "$ref": "status.json"
    },
    "uiStatus": {
      "description": "Status that is rendered on UI",
      "type": "string",
      "$ref": "uiStatus.json"
    },
    "errorStatus": {
      "description": "Status that describe error state of job execution",
      "type": "string",
      "$ref": "errorStatus.json"
    },
    "userId": {
      "description": "ID of the user who created the JobExecution",
      "type": "string"
    }
  },
  "required": [
    "id",
    "parentJobId",
    "subordinationType",
    "status",
    "uiStatus",
    "userId"
  ]
}

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error

POST /change-manager/records/{jobExecutionId}

Receive chunk of raw records

POST /change-manager/records/{jobExecutionId}
URI Parameters
  • jobExecutionId: required (string)
Body

Media type: application/json

Response 204

Body

Media type: text/plain

Type: any

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 404

Not found

Body

Media type: text/plain

Type: any

Example:

Not found

Response 422

Unprocessable Entity

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error