{ "opencollection": "1.0.0", "info": { "name": "HighBond API Reference Actions Request Items API", "version": "1.1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Request Items", "type": "folder" }, "items": [ { "info": { "name": "Get organization's request items", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/request_items", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "fields[request_items]", "value": "created_at,updated_at,description,owner,owner_email,received,request_item_status,requestor,due_date,send_recurrent_notifications,email_subject,email_message,position,project_type,owner,project,owner_user,requestor_user,cc_users,cc_contacts,contact_reference_name,contact_reference_email,contact_reference_table_id,contact_reference_record_id,target", "type": "query", "description": "Requesting the API to return only specific fields. For more information, see Making requests" }, { "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 Base64-encoded page number of records to return." }, { "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": "filter[project.id]", "value": "", "type": "query", "description": "Requesting the API to filter results by project ID. For more information, see Making requests" }, { "name": "filter[project.name]", "value": "", "type": "query", "description": "Requesting the API to filter results by project name. For more information, see Making requests" }, { "name": "filter[project.status]", "value": "", "type": "query", "description": "Requesting the API to filter results by project status. Draft, Proposed, Active, Completed (these values are customizable by customers) For more information, see Making requests" }, { "name": "filter[target.id]", "value": "", "type": "query", "description": "Requesting the API to filter results by target ID. For more information, see Making requests" }, { "name": "filter[target.type]", "value": "", "type": "query", "description": "Requesting the API to filter results by target type. For more information, see Making requests" }, { "name": "filter[received]", "value": "", "type": "query", "description": "Requesting the API to filter results by received state. For more information, see Making requests" } ] }, "docs": "Get a list of all request items in an organization." }, { "info": { "name": "Create a request item", "type": "http" }, "http": { "method": "POST", "url": "{protocol}://{server}/v1/orgs/:org_id/projects/:project_id/request_items", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "The ID of the HighBond instance." }, { "name": "project_id", "value": "", "type": "path", "description": "The ID of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new request item in an existing project.\n\nLimitations:\n* There can be a maximum of 5000 request items per project.\n" }, { "info": { "name": "Get a request item", "type": "http" }, "http": { "method": "GET", "url": "{protocol}://{server}/v1/orgs/:org_id/request_items/: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": "Get information about a request item." }, { "info": { "name": "Update a request item", "type": "http" }, "http": { "method": "PATCH", "url": "{protocol}://{server}/v1/orgs/:org_id/request_items/: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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make changes to a request item." }, { "info": { "name": "Delete a request item", "type": "http" }, "http": { "method": "DELETE", "url": "{protocol}://{server}/v1/orgs/:org_id/request_items/: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 request item from a project" } ] } ], "bundled": true }