Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetProposal

Returns detailed information about a proposal.

Request Syntax


GET /networks/networkId/proposals/proposalId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

networkId

The unique identifier of the network for which the proposal is made.

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: Yes

proposalId

The unique identifier of the proposal.

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Proposal": { 
      "Actions": { 
         "Invitations": [ 
            { 
               "Principal": "string"
            }
         ],
         "Removals": [ 
            { 
               "MemberId": "string"
            }
         ]
      },
      "CreationDate": number,
      "Description": "string",
      "ExpirationDate": number,
      "NetworkId": "string",
      "NoVoteCount": number,
      "OutstandingVoteCount": number,
      "ProposalId": "string",
      "ProposedByMemberId": "string",
      "ProposedByMemberName": "string",
      "Status": "string",
      "YesVoteCount": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Proposal

Information about a proposal.

Type: Proposal object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServiceErrorException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidRequestException

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

ResourceNotFoundException

A requested resource does not exist on the network. It may have been deleted or referenced inaccurately.

HTTP Status Code: 404

ThrottlingException

The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.

HTTP Status Code: 429