1. API
  2. REST API
  3. REST API Endpoint Reference
  4. Job Codes
  5. Update a Job Code

Update a Job Code

PUT /job-codes/{id} — Use this method to update the job code record with the specified internal ID.

Parameters

Path parameters

Path parameter

Required / Optional

Description

Type

{id}

Required

The internal ID of the job code.

integer

Query string parameter

Path parameter

Required / Optional

Description

Type

fields

Optional

A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for the job code returned.

string

filterSetId

Optional

The internal ID of the filter set to be applied.

  • When specified, the request is successful only if the action is available when the specified filter set is active in SuiteProjects Pro. The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token.

  • Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.

integer

return_object

Optional

If set to any value other than 0 (zero), the response will include the job code updated. Otherwise, the response will include only the internal ID of the job code updated.

Boolean

Request body

An object including valid key-value pairs for the fields to be updated. The object cannot include key-value pairs for read-only attributes. For information about the JobCode object model, see JobCode object properties.

Response definitions

A successful request returns a JSON object with the following properties:

Property

Description

data

An array containing one of the following:

  • The JobCode object updated, if the return_object parameter was set to any value other than 0 (zero) in the request. The object includes all the attributes specified using the fields if included in the request.

  • An object with only the ID of the job code updated.

See Returned Data.

message

A string containing a brief message about the status of your request — for example, “Success”.

A failed request returns a JSON object with the following properties:

Property

Description

message

A string containing a brief message about the status of your request — for example, “JobCode #8 not found”.

Sample request

            PUT /rest/v1/job-codes/8 HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Authorization: Bearer <OAuth2_access_token>

{
   "loadedCost": 137.5,
}

In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to SuiteProjects Pro. See Authentication.

Sample response

            {
   "data": [
      {
         "id": 8
      }
   ],
   "message": "success"
}