JobNote

Quick Reference

Method

Endpoint

Description

GET

/api/job/{jobDisplayId}/note

POST

/api/job/{jobDisplayId}/note

GET

/api/job/{jobDisplayId}/note/{id}

PUT

/api/job/{jobDisplayId}/note/{id}

GET /api/job/{jobDisplayId}/note

Parameters:

Path Parameters:

  • jobDisplayId (string, path) (required): No description available

Query Parameters:

  • category (string, query): No description available

  • taskCode (string, query): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/job/{jobDisplayId}/note"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

Sample Response:

1{
2  "status": "success",
3  "data": {}
4}

POST /api/job/{jobDisplayId}/note

Parameters:

Path Parameters:

  • jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/job/{jobDisplayId}/note"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{
2  "id": "789e0123-e89b-12d3-a456-426614174002",
3  "status": "created",
4  "message": "Resource created successfully"
5}

GET /api/job/{jobDisplayId}/note/{id}

Parameters:

Path Parameters:

  • id (integer, path) (required): No description available

  • jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/job/{jobDisplayId}/note/{id}"
,
    id="789e0123-e89b-12d3-a456-426614174002"
,
    jobDisplayId="2000000"

)

# Process the response
print(response)

Sample Response:

1{}

PUT /api/job/{jobDisplayId}/note/{id}

Parameters:

Path Parameters:

  • id (integer, path) (required): No description available

  • jobDisplayId (string, path) (required): No description available

Example Request:

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/job/{jobDisplayId}/note/{id}"
,
    id="789e0123-e89b-12d3-a456-426614174002"
,
    jobDisplayId="2000000"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

1{}