{ "opencollection": "1.0.0", "info": { "name": "HighBond API Reference Actions Time entries API", "version": "1.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Time entries", "type": "folder" }, "items": [ { "info": { "name": "Get time entries", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/time_entries", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "page[size]", "value": "", "type": "query", "description": "The number of items returned per page. Default is 50. Maximum is 100." }, { "name": "page[number]", "value": "", "type": "query", "description": "The page number of records to return. Default is 1." }, { "name": "include", "value": "", "type": "query", "description": "Requesting the API to return related resources. For more information, see Making requests" }, { "name": "filter[uid]", "value": "", "type": "query", "description": "Requesting the API to filter results by user. For more information, see Making requests" }, { "name": "filter[date][start]", "value": "", "type": "query", "description": "Requesting the API to filter results by start date. For more information, see Making requests" }, { "name": "filter[date][end]", "value": "", "type": "query", "description": "Requesting the API to filter results by end date. For more information, see Making requests" }, { "name": "filter[target.type]", "value": "", "type": "query", "description": "Requesting the API to filter results by target's type. For more information, see Making requests" }, { "name": "filter[target.id]", "value": "", "type": "query", "description": "Requesting the API to filter results by target's id. For more information, see Making requests" }, { "name": "sort", "value": "", "type": "query", "description": "Orders the resulting resources by the given field(s). Sorts ascending by default, prefix with `-` to sort descending. You can provide multiple sort fields separated by comma." }, { "name": "fields[time_entries]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[projects]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[controls]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_tests]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[issues]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[narratives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[objectives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[risks]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[accounts]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_test_plans]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[project_files]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[testing_rounds]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[walkthroughs]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" } ] }, "docs": "Get a list of all time entries in an organization." }, { "info": { "name": "Create a time entry", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/time_entries", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "include", "value": "", "type": "query", "description": "Requesting the API to return related resources. For more information, see Making requests" }, { "name": "fields[time_entries]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[projects]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[controls]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_tests]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[issues]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[narratives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[objectives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[risks]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[accounts]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_test_plans]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[project_files]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[testing_rounds]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[walkthroughs]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new time entry.\n\nLimitations:\n* There can be a maximum of 300,000 time entries per HighBond instance.\n" }, { "info": { "name": "Get information about a time entry", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/time_entries/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." }, { "name": "include", "value": "", "type": "query", "description": "Requesting the API to return related resources. For more information, see Making requests" }, { "name": "fields[time_entries]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[projects]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[controls]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_tests]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[issues]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[narratives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[objectives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[risks]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[accounts]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_test_plans]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[project_files]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[testing_rounds]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[walkthroughs]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" } ] }, "docs": "Get information about a time entry.\n" }, { "info": { "name": "Update a time entry", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{server}/v1/orgs/:org_id/time_entries/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." }, { "name": "include", "value": "", "type": "query", "description": "Requesting the API to return related resources. For more information, see Making requests" }, { "name": "fields[time_entries]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[projects]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[controls]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_tests]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[issues]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[narratives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[objectives]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[risks]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[accounts]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[control_test_plans]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[project_files]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[testing_rounds]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" }, { "name": "fields[walkthroughs]", "value": "", "type": "query", "description": "Requesting the API to return only the specified fields. For more information, see Making requests" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make changes to a time entry.\n" }, { "info": { "name": "Delete a time entry", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/time_entries/:id", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "id", "value": "", "type": "path", "description": "The ID of the requested resource." } ] }, "docs": "Permanently delete a time entry.\n" } ] } ], "bundled": true }