Job Value Assessments

Job Value Assessments is the master data to store the name of the area or city and the minimum wage per year.

GET/v1/job-value-assessments

List job value assessments

This endpoint allows you to retrieve a paginated list of all your job value assessments.

Request

Optional query

Name
page
Type
integer
Description
The page number of job value assessments returned.
- Default 1
Name
page_size
Type
integer
Description
The page size number of job value assessments returned.
- Default 10

Response

Name
data
Type
array<object>
Description
Array of job value metric object
Name
data._id
Type
string
Description
Unique identifier for the job value metric.
Name
data.name
Type
string
Description
The name for the job value metric.
Name
data.category
Type
string
Description
The category for the job value metric.
Name
data.scale_1_description
Type
string
Description
The scale 1 description for the job value metric.
Name
data.scale_1_score
Type
string
Description
The scale 1 score for the job value metric.
Name
data.scale_2_description
Type
string
Description
The scale 2 description for the job value metric.
Name
data.scale_2_score
Type
string
Description
The scale 2 score for the job value metric.
Name
data.scale_3_description
Type
string
Description
The scale 3 description for the job value metric.
Name
data.scale_3_score
Type
string
Description
The scale 3 score for the job value metric.
Name
data.scale_4_description
Type
string
Description
The scale 4 description for the job value metric.
Name
data.scale_4_score
Type
string
Description
The scale 4 score for the job value metric.
Name
data.scale_5_description
Type
string
Description
The scale 5 description for the job value metric.
Name
data.scale_5_score
Type
string
Description
The scale 5 score for the job value metric.
Name
data.is_draft
Type
boolean
Description
Is draft status.
Name
data.approval_at
Type
datetime
Description
Datetime of when the job value metric was approved.
Name
data.approval_by
Type
string
Description
User identifier who sign approval the job value metric.
Name
data.approval_status
Type
string
Description
approval status.
Name
data.created_at
Type
datetime
Description
Datetime of when the job value metric was created.
Name
data.created_by
Type
string
Description
User identifier who create the job value metric.
Name
data.updated_at
Type
datetime
Description
Datetime of when the job value metric was updated.
Name
data.updated_by
Type
string
Description
User identifier who update the job value metric.
Name
pagination
Type
object
Description
Object of Pagination
Name
pagination.page
Type
number
Description
Page number.
Name
pagination.page_size
Type
number
Description
Number of total document per page.
Name
pagination.page_count
Type
number
Description
Total page count.
Name
pagination.total_document
Type
number
Description
Total filtered document.

Request

GET

/v1/job-value-assessments

const response = axios.get('/v1/job-value-assessments', {
  params: {
    page:1,
    page_size: 10
  }
})

Response

{
  "data": [
    {
      "_id": "637b569149e0c02e1036c35a",
      "category": "Metric Category",
      "name": "Metric Name",
      "scale_1_description": "Scale 1",
      "scale_1_score": "2.1",
      "scale_2_description": "Scale 2",
      "scale_2_score": "3.4",
      "scale_3_description": "Scale 3",
      "scale_3_score": "5.5",
      "scale_4_description": "Scale 4",
      "scale_4_score": "7.24",
      "scale_5_description": "Scale 5",
      "scale_5_score": "9.21",
      "is_draft": "false",
      "approval_status": "pending",
      "approval_by": "637d83d15d2be122007524bf",
      "approval_at": "2022-01-01T00:00:00.000Z",
      "created_by": "637d83d15d2be122007524bf",
      "created_at": "2022-01-01T00:00:00.000Z",
    },
  ],
  "pagination": {
    "page": 1,
    "page_size": 1,
    "page_count": 1,
    "total_document": 2
  }
}

POST/v1/job-value-assessments

Create job value metric

This endpoint allows you to add a new job value metric.

Request

Required attributes

Name
data.name
Type
string
Description
The name for the job value metric.
Name
data.category
Type
string
Description
The category for the job value metric.
Name
data.scale_1_description
Type
string
Description
The scale 1 description for the job value metric.
Name
data.scale_1_score
Type
string
Description
The scale 1 score for the job value metric.
Name
data.scale_2_description
Type
string
Description
The scale 2 description for the job value metric.
Name
data.scale_2_score
Type
string
Description
The scale 2 score for the job value metric.
Name
data.scale_3_description
Type
string
Description
The scale 3 description for the job value metric.
Name
data.scale_3_score
Type
string
Description
The scale 3 score for the job value metric.
Name
data.scale_4_description
Type
string
Description
The scale 4 description for the job value metric.
Name
data.scale_4_score
Type
string
Description
The scale 4 score for the job value metric.
Name
data.scale_5_description
Type
string
Description
The scale 5 description for the job value metric.
Name
data.scale_5_score
Type
string
Description
The scale 5 score for the job value metric.
Name
data.is_draft
Type
boolean
Description
Is draft status.
Name
data.approval_by
Type
string
Description
User identifier who sign approval the job value metric.

Response

Name
_id
Type
string
Description
Unique identifier for the job value metric.

Request

POST

/v1/job-value-assessments

const response = axios.post('/v1/job-value-assessments', {
  category: "Metric Category",
  name: "Metric Name",
  scale_1_description: "Scale 1",
  scale_1_score: "2.1",
  scale_2_description: "Scale 2",
  scale_2_score: "3.4",
  scale_3_description: "Scale 3",
  scale_3_score: "5.5",
  scale_4_description: "Scale 4",
  scale_4_score: "7.24",
  scale_5_description: "Scale 5",
  scale_5_score: "9.21",
  is_draft: "false",
  approval_by: "637d83d15d2be122007524bf",
})

Response

{
  "inserted_id": "637d83d15d2be122007524bf"
}

GET/v1/job-value-assessments/:id

Retrieve job value metric

This endpoint allows you to retrieve a job value metric by providing their id.

Response

Name
_id
Type
string
Description
Unique identifier for the job value metric.
Name
data.name
Type
string
Description
The name for the job value metric.
Name
data.category
Type
string
Description
The category for the job value metric.
Name
data.scale_1_description
Type
string
Description
The scale 1 description for the job value metric.
Name
data.scale_1_score
Type
string
Description
The scale 1 score for the job value metric.
Name
data.scale_2_description
Type
string
Description
The scale 2 description for the job value metric.
Name
data.scale_2_score
Type
string
Description
The scale 2 score for the job value metric.
Name
data.scale_3_description
Type
string
Description
The scale 3 description for the job value metric.
Name
data.scale_3_score
Type
string
Description
The scale 3 score for the job value metric.
Name
data.scale_4_description
Type
string
Description
The scale 4 description for the job value metric.
Name
data.scale_4_score
Type
string
Description
The scale 4 score for the job value metric.
Name
data.scale_5_description
Type
string
Description
The scale 5 description for the job value metric.
Name
data.scale_5_score
Type
string
Description
The scale 5 score for the job value metric.
Name
data.is_draft
Type
boolean
Description
Is draft status.
Name
data.approval_at
Type
datetime
Description
Datetime of when the job value metric was approved.
Name
data.approval_by
Type
string
Description
User identifier who sign approval the job value metric.
Name
data.approval_status
Type
string
Description
approval status.
Name
created_at
Type
datetime
Description
Datetime of when the job value metric was created.
Name
created_by
Type
string
Description
User identifier who create the job value metric.
Name
updated_at
Type
datetime
Description
Datetime of when the job value metric was updated.
Name
updated_by
Type
string
Description
User identifier who update the job value metric.

Request

GET

/v1/job-value-assessments/:id

const response = axios.get('/v1/job-value-assessments/637d83d15d2be122007524bf')

Response

{
  "_id": "637d83d15d2be122007524bf",
  "category": "Metric Category",
  "name": "Metric Name",
  "scale_1_description": "Scale 1",
  "scale_1_score": "2.1",
  "scale_2_description": "Scale 2",
  "scale_2_score": "3.4",
  "scale_3_description": "Scale 3",
  "scale_3_score": "5.5",
  "scale_4_description": "Scale 4",
  "scale_4_score": "7.24",
  "scale_5_description": "Scale 5",
  "scale_5_score": "9.21",
  "is_draft": "false",
  "approval_status": "pending",
  "approval_by": "637d83d15d2be122007524bf",
  "approval_at": "2022-01-01T00:00:00.000Z",
  "created_by": "637d83d15d2be122007524bf",
  "created_at": "2022-01-01T00:00:00.000Z",
}

PATCH/v1/job-value-assessments/:id

Update job value metric

This endpoint allows you to perform an update on a job value metric.

Request

Required attributes

Name
data.name
Type
string
Description
The name for the job value metric.
Name
data.category
Type
string
Description
The category for the job value metric.
Name
data.scale_1_description
Type
string
Description
The scale 1 description for the job value metric.
Name
data.scale_1_score
Type
string
Description
The scale 1 score for the job value metric.
Name
data.scale_2_description
Type
string
Description
The scale 2 description for the job value metric.
Name
data.scale_2_score
Type
string
Description
The scale 2 score for the job value metric.
Name
data.scale_3_description
Type
string
Description
The scale 3 description for the job value metric.
Name
data.scale_3_score
Type
string
Description
The scale 3 score for the job value metric.
Name
data.scale_4_description
Type
string
Description
The scale 4 description for the job value metric.
Name
data.scale_4_score
Type
string
Description
The scale 4 score for the job value metric.
Name
data.scale_5_description
Type
string
Description
The scale 5 description for the job value metric.
Name
data.scale_5_score
Type
string
Description
The scale 5 score for the job value metric.
Name
data.is_draft
Type
boolean
Description
Is draft status.
Name
data.approval_by
Type
string
Description
User identifier who sign approval the job value metric.

Request

PATCH

/v1/job-value-assessments/:id

const response = axios.patch('/v1/job-value-assessments/637d83d15d2be122007524bf', {
  category: "Metric Category",
  name: "Metric Name",
  scale_1_description: "Scale 1",
  scale_1_score: "2.1",
  scale_2_description: "Scale 2",
  scale_2_score: "3.4",
  scale_3_description: "Scale 3",
  scale_3_score: "5.5",
  scale_4_description: "Scale 4",
  scale_4_score: "7.24",
  scale_5_description: "Scale 5",
  scale_5_score: "9.21",
  is_draft: "false",
  approval_by: "637d83d15d2be122007524bf",
})

Response

{
  "matched_count": 1,
  "modified_count": 1
}

DELETE/v1/job-value-assessments/:id

Delete job value metric

This endpoint allows you to delete job value assessments from your job value metric list.

Request

DELETE

/v1/job-value-assessments/:id

const response = axios.delete('/v1/job-value-assessments/637d83d15d2be122007524bf')

Response

{
  "deleted_count": 1
}