{ "opencollection": "1.0.0", "info": { "name": "Pryon Feedback API", "version": "1.0" }, "items": [ { "info": { "name": "Feedback", "type": "folder" }, "items": [ { "info": { "name": "ListApprovals", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1/approvals", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Required. Knowledge Domain under which approval items are listed." }, { "name": "kd_succession_id", "value": "", "type": "query", "description": "Optional. Collection ID for KD, if present.\nIf request contains kd_succession_id, filter on it instead of knowledge_domain_id." }, { "name": "approval_status", "value": "", "type": "query", "description": "Optional. Filter only items with this Approval status.\n\n - PENDING_REVIEW: PENDING_REVIEW: This approval item is pending review\n - REJECTED: REJECTED: This approval item has been rejected\n - APPROVED: APPROVED: This approval item has been approved" }, { "name": "return_only_item_keys", "value": "", "type": "query", "description": "Optional. Return only the item keys when set to True." }, { "name": "page_size", "value": "", "type": "query", "description": "Default page size is 100 when omitted. The maximum page size is 100.\nThe REST query parameter is \"page_size\".\nSee https://cloud.google.com/apis/design/design_patterns#list_pagination for details." }, { "name": "page_token", "value": "", "type": "query", "description": "If there are multiple pages, pages 2-N must specify this parameter using the value of next_page_token provided in the previous page's response. The REST query parameter is \"page_token\".\nSee https://cloud.google.com/apis/design/design_patterns#list_pagination for details." }, { "name": "order_by", "value": "", "type": "query", "description": "If there are multiple pages, a sort order can be used and is applicable to the pages but not to the items in a page.\nIf the sort order parameter is provided with a multi-page request, it must be provided on all subsequent page requests.\nSupported options are: \"update_time desc\" and \"update_time asc\".\nSee https://cloud.google.com/apis/design/design_patterns#sorting_order for details." } ] }, "docs": "List Approval entries based on filters.\nFor a REST call filtering, params need to be passed in the request query string\nSupported filters:\nknowledge_domain_id (required)\nkd_succession_id (optional)\napproval_status (optional)" }, { "info": { "name": "CreateApproval", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1/approvals", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Approval entry." }, { "info": { "name": "GetApproval", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1/approvals/:approval_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "approval_id", "value": "", "type": "path", "description": "Required. Must be a valid UUID." } ] }, "docs": "Get information about an Approval entry." }, { "info": { "name": "DeleteApproval", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/conversation/v1/approvals/:approval_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "approval_id", "value": "", "type": "path", "description": "Required. approval_id of item to be deleted." } ] }, "docs": "Delete an Approval entry." }, { "info": { "name": "UpdateApproval", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1/approvals/:data.approval_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.approval_id", "value": "", "type": "path", "description": "Optional. Random UUID generated on a CreateApproval request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing Approval entry." }, { "info": { "name": "ListExchangeRatingReviews", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1/rating-reviews", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "Required. Filter list output to only include ratings for a knowledge collection. In REST form the parameter is expressed as 'collection_id'." }, { "name": "exchange_id", "value": "", "type": "query", "description": "Filter list output to only include ratings for a particular exchange. Overrides the collection_id filter value if supplied. Defaults to empty which disables this filter. In REST form the parameter is expressed as 'exchange_id'." }, { "name": "status", "value": "", "type": "query", "description": "Filter list output to only include ratings that are in requested review status. Defaults to UNSPECIFIED which disables this filter. In REST form the parameter is expressed as 'status' with valid values PENDING and COMPLETE.\n\n - UNSPECIFIED: Not a valid exchange rating value\n - PENDING: This exchange rating is waiting to be inspected for approval or rejection (default).\n - COMPLETE: This exchange rating has been inspected and acted upon. No further action will be taken." }, { "name": "creator_id", "value": "", "type": "query", "description": "Filter list output to only include ratings made by a given user. In REST form the parameter is expressed as 'creator_id'." }, { "name": "rank", "value": "", "type": "query", "description": "Filter list output to only include ratings that match a given rank value. In REST form the parameter is expressed as 'rank' with valid values 1-5." }, { "name": "page_size", "value": "", "type": "query", "description": "Default page size is 100 when omitted. The maximum page size is 100.\nThe REST query parameter is \"page_size\".\nSee https://cloud.google.com/apis/design/design_patterns#list_pagination for details." }, { "name": "page_token", "value": "", "type": "query", "description": "If there are multiple pages, pages 2-N must specify this parameter using the value of next_page_token provided in the previous page's response. The REST query parameter is \"page_token\".\nSee https://cloud.google.com/apis/design/design_patterns#list_pagination for details." }, { "name": "order_by", "value": "", "type": "query", "description": "If the sort order parameter is provided with a multi page request, it must be provided on all subsequent page requests.\nFor exchange requests the valid options are: rank, rank desc, create_time, create_time desc.\nsee https://cloud.google.com/apis/design/design_patterns#sorting_order." } ] }, "docs": "List exchange rating reviews.\nAccepted REST filter parameters:\ncollection_id (required)\nexchange_id (optional)\ncreator_id (optional)\nrank (optional)\nstatus (optional)" }, { "info": { "name": "CreateExchangeRating", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1/ratings", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an exchange rating." }, { "info": { "name": "UpdateExchangeRatingReview", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1/ratings/:data.rating.rating_id/review", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating.rating_id", "value": "", "type": "path", "description": "UUID that uniquely identifies a particular exchange rating. Automatically generated on create." } ], "body": { "type": "json", "data": "{}" } }, "docs": "A reviewing authority can update the review perspective of an exchange rating item. This includes review information not available to un-privileged users." }, { "info": { "name": "UpdateExchangeRating", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1/ratings/:data.rating_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating_id", "value": "", "type": "path", "description": "UUID that uniquely identifies a particular exchange rating. Automatically generated on create." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing exchange rating." }, { "info": { "name": "GetExchangeRating", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1/ratings/:rating_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path" } ] }, "docs": "Retrieve an exchange rating." }, { "info": { "name": "DeleteExchangeRating", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/conversation/v1/ratings/:rating_id", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path" } ] }, "docs": "Delete an exchange rating." }, { "info": { "name": "GetExchangeRatingReview", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1/ratings/:rating_id/review", "headers": [ { "name": "Authentication", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path" } ] }, "docs": "A reviewing authority can retrieve the review perspective of an exchange rating item. This includes review information not available to un-privileged users." } ] } ], "bundled": true }