URL Expired

The URL for this request expired after 30 days.

The raw HTTP body.

Message that represents an arbitrary HTTP body. It should only be used for

payload formats that can't be represented as JSON, such as raw binary or

an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest {
  // A unique request id.
  string request_id = 1;

// The raw HTTP body is bound to this field.
  google.api.HttpBody http_body = 2;

}

service ResourceService {
  rpc GetResource(GetResourceRequest)
    returns (google.api.HttpBody);
  rpc UpdateResource(google.api.HttpBody)
    returns (google.protobuf.Empty);

}

Example with streaming methods:

service CaldavService {
  rpc GetCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);
  rpc UpdateCalendar(stream google.api.HttpBody)
    returns (stream google.api.HttpBody);

}

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

contentType

string

The HTTP Content-Type header value specifying the content type of the body.

data

string

The HTTP request/response body as raw binary.

extensions

array of objects

Application specific response metadata. Must be set in the first response for streaming APIs.

extensions ADD object

`` 200 A successful response.

object

The response for the UploadOpenCapTable endpoint.

openCapTable

object

The open cap table data.

id

string

length between 1 and 1000

The id for a submitted OCF package

createTime

object

required

The timestamp of when this OCF package has been submitted.

createTime object

completeTime

object

The timestamp of when this OCF package has completed processing.

The timestamp of when this OCF package has completed processing object

state

string

enum

required

The state at which the importing/processing of the OCF package is at.

details

array of objects

The log details of the import/processing of the submitted OCF package.

details

object

A log detailing an inner step of the import/processing of a submitted OCF package.

id

string

length between 1 and 1000

The id for a submitted OCF package log entry. References a single step.

createTime

object

required

The timestamp of a submitted OCF package log entry. Uses UTC by default.

createTime object

metadata

array of objects

The metadata of a submitted OCF package log entry. This field is optional.

metadata

object

A struct to carry metadata associated with an inner step of the import/processing of a submitted OCF package.

details

string

length between 1 and 1000

The details that represent this metadata

`` 400 Returned if required fields are omitted or if provided fields fail validation.

`` 401 Returned if a valid Authorization header has not been included with the request.

`` 403 Returned when the user does not have permission to access the resource.

`` 500 Returned if an unexpected internal server error is encountered.

`` default An unexpected error response.

{
  "openCapTable": {
    "id": "39e581eb-7312-4acc-b239-5536fa978df5",
    "state": "PROCESSING",
    "createTime": {
      "value": "2022-10-28T16:00:00Z"
    },
    "completeTime": null,
    "details": [
      {
        "id": "39e581eb-7312-4acc-b239-5536fa978df6",
        "createTime": {
          "value": "2022-10-28T17:00:00Z"
        },
        "metadata": {
          "details": "OCF upload started"
        }
      }
    ]
  }
}

curl --request POST \
     --url https://mock-api.carta.com/v1alpha1/openCapTables \
     --header 'accept: application/json' \
     --header 'content-type: application/json'