{ "apiVersion": "1.0", "swaggerVersion": "1.2", "basePath": "https://api.publicstuff.com", "resourcePath": "requests", "apis": [ { "path": "/app/requests", "operations": [ { "summary": "Show a list of Request objects", "parameters": [ { "paramType": "query", "name": "page", "type": "integer", "description": "Get additional pages of index queries", "required": false }, { "paramType": "query", "name": "limit", "type": "integer", "description": "Set the number of items to retrieve (default: 30, max: 500)", "required": false }, { "paramType": "header", "name": "Authorization", "type": "string", "description": "Authorization token", "required": true, "defaultValue": "Token token={token}" }, { "paramType": "header", "name": "PublicStuff-Session-Token", "type": "string", "description": "Session token", "required": false }, { "paramType": "query", "name": "ids", "type": "array_or_scalar", "description": "Limit the collection to a set of IDs", "required": false }, { "paramType": "query", "name": "not_ids", "type": "array_or_scalar", "description": "Exclude from the collection a set of IDs", "required": false }, { "paramType": "query", "name": "since", "type": "timestamp", "description": "Limit to objects created after timestamp", "required": false }, { "paramType": "query", "name": "after", "type": "timestamp", "description": "Limit to objects created after timestamp", "required": false }, { "paramType": "query", "name": "before", "type": "timestamp", "description": "Limit to objects created before timestamp", "required": false }, { "paramType": "query", "name": "sort_key", "type": "string", "description": "Which column to sort by", "required": false }, { "paramType": "query", "name": "sort_dir", "type": "string", "description": "Which direction to sort", "required": false }, { "paramType": "query", "name": "filters[id]", "type": "string", "description": "Match Id", "required": false }, { "paramType": "query", "name": "filters[name]", "type": "string", "description": "Match Name", "required": false }, { "paramType": "query", "name": "filters[description]", "type": "string", "description": "Match Description", "required": false }, { "paramType": "query", "name": "filters[created_at]", "type": "string", "description": "Match Created at", "required": false }, { "paramType": "query", "name": "filters[updated_at]", "type": "string", "description": "Match Updated at", "required": false }, { "paramType": "query", "name": "filters[deleted_at]", "type": "string", "description": "Match Deleted at", "required": false }, { "paramType": "query", "name": "filters[request_type_id]", "type": "string", "description": "Match Request type", "required": false }, { "paramType": "query", "name": "filters[creator_id]", "type": "string", "description": "Match Creator", "required": false }, { "paramType": "query", "name": "filters[workflow_node_id]", "type": "string", "description": "Match Workflow node", "required": false }, { "paramType": "query", "name": "filters[status]", "type": "string", "description": "Match Status", "required": false }, { "paramType": "query", "name": "filters[api_source_id]", "type": "string", "description": "Match Api source", "required": false }, { "paramType": "query", "name": "filters[priority]", "type": "string", "description": "Match Priority", "required": false }, { "paramType": "query", "name": "filters[geo_location_id]", "type": "string", "description": "Match Geo location", "required": false }, { "paramType": "query", "name": "filters[locale_origin]", "type": "string", "description": "Match Locale origin", "required": false }, { "paramType": "query", "name": "filters[workflow_graph_id]", "type": "string", "description": "Match Workflow graph", "required": false }, { "paramType": "query", "name": "filters[primary_attachment_id]", "type": "string", "description": "Match Primary attachment", "required": false }, { "paramType": "query", "name": "filters[reporter_id]", "type": "string", "description": "Match Reporter", "required": false }, { "paramType": "query", "name": "filters[attachments_count]", "type": "string", "description": "Match Attachments count", "required": false }, { "paramType": "query", "name": "filters[flags_count]", "type": "string", "description": "Match Flags count", "required": false }, { "paramType": "query", "name": "filters[follows_count]", "type": "string", "description": "Match Follows count", "required": false }, { "paramType": "query", "name": "filters[comments_count]", "type": "string", "description": "Match Comments count", "required": false }, { "paramType": "query", "name": "filters[tags_count]", "type": "string", "description": "Match Tags count", "required": false }, { "paramType": "query", "name": "filters[due_at]", "type": "string", "description": "Match Due at", "required": false }, { "paramType": "query", "name": "filters[completed_at]", "type": "string", "description": "Match Completed at", "required": false }, { "paramType": "query", "name": "filters[display_foreign_id]", "type": "string", "description": "Match Display foreign", "required": false }, { "paramType": "query", "name": "filters[average_rating]", "type": "string", "description": "Match Average rating", "required": false }, { "paramType": "query", "name": "filters[ratings_count]", "type": "string", "description": "Match Ratings count", "required": false }, { "paramType": "query", "name": "filters[use_permission_matrix]", "type": "string", "description": "Match Use permission matrix", "required": false }, { "paramType": "query", "name": "filters[permissions_poro]", "type": "string", "description": "Match Permissions poro", "required": false }, { "paramType": "query", "name": "filters[contact_info_first_name]", "type": "string", "description": "Match Contact info first name", "required": false }, { "paramType": "query", "name": "filters[contact_info_last_name]", "type": "string", "description": "Match Contact info last name", "required": false }, { "paramType": "query", "name": "filters[contact_info_email]", "type": "string", "description": "Match Contact info email", "required": false }, { "paramType": "query", "name": "filters[contact_info_phone]", "type": "string", "description": "Match Contact info phone", "required": false }, { "paramType": "query", "name": "filters[contact_info_username]", "type": "string", "description": "Match Contact info username", "required": false }, { "paramType": "query", "name": "filters[contact_info_user_id]", "type": "string", "description": "Match Contact info user", "required": false }, { "paramType": "query", "name": "filters[foreign_associations_count]", "type": "string", "description": "Match Foreign associations count", "required": false }, { "paramType": "query", "name": "filters[expected_responded_at]", "type": "string", "description": "Match Expected responded at", "required": false }, { "paramType": "query", "name": "filters[responded_at]", "type": "string", "description": "Match Responded at", "required": false }, { "paramType": "query", "name": "filters[completion_time_s]", "type": "string", "description": "Match Completion time s", "required": false }, { "paramType": "query", "name": "filters[expected_completion_time_s]", "type": "string", "description": "Match Expected completion time s", "required": false }, { "paramType": "query", "name": "filters[response_time_s]", "type": "string", "description": "Match Response time s", "required": false }, { "paramType": "query", "name": "filters[expected_response_time_s]", "type": "string", "description": "Match Expected response time s", "required": false }, { "paramType": "query", "name": "filters[default_due_at]", "type": "string", "description": "Match Default due at", "required": false }, { "paramType": "query", "name": "filters[default_expected_responded_at]", "type": "string", "description": "Match Default expected responded at", "required": false }, { "paramType": "query", "name": "filters[client_id]", "type": "string", "description": "Match Client", "required": false }, { "paramType": "query", "name": "date_column", "type": "string", "description": "Which column to apply filter to", "required": false }, { "paramType": "query", "name": "in_day", "type": "timestamp", "description": "Date column should share the same day", "required": false }, { "paramType": "query", "name": "in_week", "type": "timestamp", "description": "Date column should share the same week", "required": false }, { "paramType": "query", "name": "in_month", "type": "timestamp", "description": "Date column should share the same month", "required": false }, { "paramType": "query", "name": "in_year", "type": "timestamp", "description": "Date column should share the same year", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "timezone", "type": "string", "description": "Set query timezone", "required": false }, { "paramType": "query", "name": "client_ids", "type": "array_or_scalar", "description": "Show only requests from this client", "required": false }, { "paramType": "query", "name": "object_field_ids", "type": "array_or_scalar", "description": "Show only requests with these object field ids", "required": false }, { "paramType": "query", "name": "request_type_group", "type": "array_or_scalar", "description": "Show only requests from these request type group ids", "required": false }, { "paramType": "query", "name": "reported_by", "type": "array_or_scalar", "description": "Show only requests reported by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "created_by", "type": "array_or_scalar", "description": "Show only requests created by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "completed_by", "type": "array_or_scalar", "description": "Show only requests completed by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "followed_by", "type": "array_or_scalar", "description": "Show only requests followed by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "commented_by", "type": "array_or_scalar", "description": "Show only requests commented by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "managed_by", "type": "array_or_scalar", "description": "Show only requests managed by these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "assigned_to", "type": "array_or_scalar", "description": "Show only requests assigned to these users. Supports \"me\"", "required": false }, { "paramType": "query", "name": "not_assigned", "type": "boolean", "description": "Show only requests that are unassigned. Supports \"me\"", "required": false }, { "paramType": "query", "name": "is_open", "type": "boolean", "description": "Show only requests that are open", "required": false }, { "paramType": "query", "name": "is_closed", "type": "boolean", "description": "Show only requests that are closed", "required": false }, { "paramType": "query", "name": "is_unresponded", "type": "boolean", "description": "Show only requests that have not been responded to", "required": false }, { "paramType": "query", "name": "is_responded", "type": "boolean", "description": "Show only requests that have been responded to", "required": false }, { "paramType": "query", "name": "has_due_at", "type": "boolean", "description": "Show only requests that have a completion due date", "required": false }, { "paramType": "query", "name": "has_expected_responded_at", "type": "boolean", "description": "Show only requests that have a response due date", "required": false }, { "paramType": "query", "name": "with_request_type_default_duration_s", "type": "boolean", "description": "Show only requests belonging to request types with a default completion SLA", "required": false }, { "paramType": "query", "name": "with_request_type_default_response_s", "type": "boolean", "description": "Show only requests belonging to request types with a default response SLA", "required": false }, { "paramType": "query", "name": "is_public", "type": "boolean", "description": "Show only requests that are visible to everyone", "required": false }, { "paramType": "query", "name": "is_internal", "type": "boolean", "description": "Show only requests that are not visible to everyone", "required": false }, { "paramType": "query", "name": "is_overdue", "type": "boolean", "description": "Show only requests that are overdue", "required": false }, { "paramType": "query", "name": "is_due_soon", "type": "boolean", "description": "Show only requests that are due soon", "required": false }, { "paramType": "query", "name": "due_status", "type": "array_or_scalar", "description": "Show only requests that have a due status in the array", "required": false }, { "paramType": "query", "name": "due_before", "type": "integer", "description": "Show only requests that are due after this date", "required": false }, { "paramType": "query", "name": "due_after", "type": "integer", "description": "Show only requests that are due before this date", "required": false }, { "paramType": "query", "name": "has_comments", "type": "boolean", "description": "Show only requests that [don't] have comments.", "required": false }, { "paramType": "query", "name": "has_attachments", "type": "boolean", "description": "Show only requests that [don't] have attachments.", "required": false }, { "paramType": "query", "name": "has_duplicates", "type": "boolean", "description": "Show only requests that [don't] have duplicates.", "required": false }, { "paramType": "query", "name": "has_object_fields", "type": "boolean", "description": "Show only requests that [don't] have duplicates.", "required": false }, { "paramType": "query", "name": "tags", "type": "array_or_scalar", "description": "Show only requests with these tags", "required": false }, { "paramType": "query", "name": "ratings", "type": "array_or_scalar", "description": "Show only requests with these ratings", "required": false }, { "paramType": "query", "name": "comment_contains", "type": "array_or_scalar", "description": "Show only requests with comments that contain these strings", "required": false }, { "paramType": "query", "name": "object_field_filter", "type": "hash", "description": "Show only requests with these object field ids (keys) and values (values)", "required": false }, { "paramType": "query", "name": "has_foreign_ids", "type": "boolean", "description": "Show only requests that [don't] have foreign ids.", "required": false }, { "paramType": "query", "name": "with_foreign_integration_id", "type": "integer", "description": "Show only requests with foreign associations of this integration id", "required": false }, { "paramType": "query", "name": "with_foreign_integration_instance_id", "type": "integer", "description": "Show only requests with foreign associations of this integration instance id", "required": false }, { "paramType": "query", "name": "within_region_id", "type": "array_or_scalar", "description": "Show only Request within regions", "required": false }, { "paramType": "query", "name": "within_geo_data_id", "type": "array_or_scalar", "description": "Show only Request within geometries", "required": false }, { "paramType": "query", "name": "nw[lat]", "type": "integer", "description": "Show only Request within bounding box", "required": false }, { "paramType": "query", "name": "nw[lon]", "type": "integer", "description": "Show only Request within bounding box", "required": false }, { "paramType": "query", "name": "se[lat]", "type": "integer", "description": "Show only Request within bounding box", "required": false }, { "paramType": "query", "name": "se[lon]", "type": "integer", "description": "Show only Request within bounding box", "required": false }, { "paramType": "query", "name": "lat", "type": "integer", "description": "Show only Request within a radius of lat/lon", "required": false }, { "paramType": "query", "name": "lon", "type": "integer", "description": "Show only Request within a radius of lat/lon", "required": false }, { "paramType": "query", "name": "radius", "type": "integer", "description": "Show only Request within a radius of lat/lon", "required": false } ], "nickname": "V1::Requests#index", "method": "get" } ] }, { "path": "/app/requests", "operations": [ { "summary": "Create a Request", "parameters": [ { "paramType": "header", "name": "Authorization", "type": "string", "description": "Authorization token", "required": true, "defaultValue": "Token token={token}" }, { "paramType": "header", "name": "PublicStuff-Session-Token", "type": "string", "description": "Session token", "required": false }, { "paramType": "form", "name": "request[name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[description]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[description]", "type": "text", "description": null, "required": false }, { "paramType": "form", "name": "request[request_type_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[creator_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[workflow_node_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[status]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[api_source_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[priority]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[geo_location_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[locale_origin]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[workflow_graph_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[primary_attachment_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[reporter_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[attachments_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[flags_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[follows_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[comments_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[tags_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[display_foreign_id]", "type": "boolean", "description": null, "required": false }, { "paramType": "form", "name": "request[average_rating]", "type": "float", "description": null, "required": false }, { "paramType": "form", "name": "request[ratings_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[use_permission_matrix]", "type": "boolean", "description": null, "required": false }, { "paramType": "form", "name": "request[permissions_poro]", "type": "json", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_first_name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_last_name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_email]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_phone]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_username]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_user_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[foreign_associations_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[completion_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[expected_completion_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[response_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[expected_response_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[client_id]", "type": "integer", "description": null, "required": false } ], "nickname": "V1::Requests#create", "method": "post" } ] }, { "path": "/app/requests/{id}", "operations": [ { "summary": "Show a Request", "parameters": [ { "paramType": "header", "name": "Authorization", "type": "string", "description": "Authorization token", "required": true, "defaultValue": "Token token={token}" }, { "paramType": "header", "name": "PublicStuff-Session-Token", "type": "string", "description": "Session token", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[only][]", "type": "string", "description": "Only include this attribute", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false }, { "paramType": "query", "name": "field[extras][]", "type": "string", "description": "Include available relationships", "required": false } ], "nickname": "V1::Requests#show", "method": "get" } ] }, { "path": "/app/requests/{id}", "operations": [ { "summary": "Update a Request", "parameters": [ { "paramType": "header", "name": "Authorization", "type": "string", "description": "Authorization token", "required": true, "defaultValue": "Token token={token}" }, { "paramType": "header", "name": "PublicStuff-Session-Token", "type": "string", "description": "Session token", "required": false }, { "paramType": "form", "name": "request[name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[description]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[description]", "type": "text", "description": null, "required": false }, { "paramType": "form", "name": "request[request_type_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[creator_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[workflow_node_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[status]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[api_source_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[priority]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[geo_location_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[locale_origin]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[workflow_graph_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[primary_attachment_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[reporter_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[attachments_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[flags_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[follows_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[comments_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[tags_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[display_foreign_id]", "type": "boolean", "description": null, "required": false }, { "paramType": "form", "name": "request[average_rating]", "type": "float", "description": null, "required": false }, { "paramType": "form", "name": "request[ratings_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[use_permission_matrix]", "type": "boolean", "description": null, "required": false }, { "paramType": "form", "name": "request[permissions_poro]", "type": "json", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_first_name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_last_name]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_email]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_phone]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_username]", "type": "string", "description": null, "required": false }, { "paramType": "form", "name": "request[contact_info_user_id]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[foreign_associations_count]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[completion_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[expected_completion_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[response_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[expected_response_time_s]", "type": "integer", "description": null, "required": false }, { "paramType": "form", "name": "request[client_id]", "type": "integer", "description": null, "required": false } ], "nickname": "V1::Requests#update", "method": "patch" } ] }, { "path": "/app/requests/{id}", "operations": [ { "summary": "Delete a Request", "parameters": [ { "paramType": "header", "name": "Authorization", "type": "string", "description": "Authorization token", "required": true, "defaultValue": "Token token={token}" }, { "paramType": "header", "name": "PublicStuff-Session-Token", "type": "string", "description": "Session token", "required": false } ], "nickname": "V1::Requests#destroy", "method": "delete" } ] }, { "path": "/app/requests/{request_id}/export_pdf", "operations": [ { "nickname": "V1::Requests#export_to_pdf", "method": "get" } ] } ], "authorizations": null }