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

GetProposal

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

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"
            }
         ]
      },
      "Arn": "string",
      "CreationDate": number,
      "Description": "string",
      "ExpirationDate": number,
      "NetworkId": "string",
      "NoVoteCount": number,
      "OutstandingVoteCount": number,
      "ProposalId": "string",
      "ProposedByMemberId": "string",
      "ProposedByMemberName": "string",
      "Status": "string",
      "Tags": { 
         "string" : "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 don't 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 doesn't exist. It may have been deleted or referenced incorrectly.

HTTP Status Code: 404

ThrottlingException

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

HTTP Status Code: 429