{ "opencollection": "1.0.0", "info": { "name": "Oracle Sender Invitation API", "version": "1.0" }, "items": [ { "info": { "name": "senderInvitation", "type": "folder" }, "items": [ { "info": { "name": "Lists sender invitations", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/senderInvitations", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "recipientTenancyId", "value": "", "type": "query", "description": "The tenancy that the invitation is addressed to." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the resource." }, { "name": "status", "value": "", "type": "query", "description": "The status of the sender invitation." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." } ] }, "docs": "Return a (paginated) list of sender invitations.\n" }, { "info": { "name": "Creates a sender invitation and asynchronously sends the invitation to recipient.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/senderInvitations", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a sender invitation and asynchronously sends the invitation to the recipient." }, { "info": { "name": "Gets information about the sender invitation.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/senderInvitations/:senderInvitationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderInvitationId", "value": "", "type": "path", "description": "OCID of the sender invitation to retrieve." } ] }, "docs": "Gets information about the sender invitation." }, { "info": { "name": "Update the SenderInvitation identified by the id.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220518/senderInvitations/:senderInvitationId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderInvitationId", "value": "", "type": "path", "description": "OCID of the sender invitation to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the sender invitation." }, { "info": { "name": "Cancels a sender invitation.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/senderInvitations/:senderInvitationId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "senderInvitationId", "value": "", "type": "path", "description": "OCID of the sender invitation to cancel." } ] }, "docs": "Cancels a sender invitation." } ] } ], "bundled": true }