Get the List of Job Codes

GET /job-codes/ — Use this method to retrieve the list of job codes.

Parameters

Path parameters

None

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 each job code returned. Response Data Modifiers.	string
filterSetId	Optional	The internal ID of the filter set to be applied. When specified, the response includes only data that 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
limit	Optional	A limit on the length of the page. See Pagination.	integer
offset	Optional	A cursor for use in pagination. See Pagination.	integer
orderBy	Optional	The attribute to sort the list by. Use a plus sign (+) or minus sign (-) before the attribute name to specify an ascending (+) or descending (-) sort order. An ascending sort order is used if the sort order is not specified. See Sorting.	string
q	Optional	A URL-encoded query expression used to filter the resource collection and return the objects matching the specified search criteria. See Filtering.	string

Response definitions

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

Property	Description
data	An array containing the job code objects requested. See Returned Data.
meta	An object containing response metadata. The meta object may include information about: The page returned, the number of objects per page, the total number of pages and objects in the list, and links to other pages. See Pagination.
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.

Sample request

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

          

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": [
      {
         ...
      },
         {
         ...
      },
         ...
   ],
   "message": "success",
   "meta": {
       "rowsPerPage": 100,
       "totalPages": 2,
       "totalRows": 138,
       "links": [
            {
                "rel": "first",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/job-codes"
            },
            {
                "rel": "self",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/job-codes"
            },
            {
                "rel": "next",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/job-codes?limit=100&offset=100"
            },
            {
                "rel": "last",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/job-codes?limit=100&offset=100"
            }
       ]
   }
  }