Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

entity

object (ListByIDReq)

entity

optional

before_sid

integer <int64> | string

before_sid

optional

start listing records less than this sid

limit

integer <int64> | string

limit

optional

max records to retrieve

other_sid

integer <int64> | string

other_sid

optional

the sid that is in the where clause

mask

string

mask

optional

FieldMask represents a set of symbolic field paths, for example:

paths: "f.a"
paths: "f.b.d"

Here f represents a field in some root message, a and b
fields in the message found in f, and d a field found in the
message in f.b.

Field masks are used to specify a subset of fields that should be
returned by a get operation or modified by an update operation.
Field masks also have a custom JSON encoding (see below).

Field Masks in Projections

When used in the context of a projection, a response message or
sub-message is filtered by the API to only contain those fields as
specified in the mask. For example, if the mask in the previous
example is applied to a response message as follows:

f {
a : 22
b {
d : 1
x : 2
}
y : 13
}
z: 8

The result will not contain specific values for fields x,y and z
(their value will be set to the default, and omitted in proto text
output):

f {
a : 22
b {
d : 1
}
}

A repeated field is not allowed except at the last position of a
paths string.

If a FieldMask object is not present in a get operation, the
operation applies to all fields (as if a FieldMask of all fields
had been specified).

Note that a field mask does not necessarily apply to the
top-level response message. In case of a REST get operation, the
field mask applies directly to the response, but in case of a REST
list operation, the mask instead applies to each individual message
in the returned resource list. In case of a REST custom method,
other definitions may be used. Where the mask applies will be
clearly documented together with its declaration in the API. In
any case, the effect on the returned resource/resources is required
behavior for APIs.

Field Masks in Update Operations

A field mask in update operations specifies which fields of the
targeted resource are going to be updated. The API is required
to only change the values of the fields as specified in the mask
and leave the others untouched. If a resource is passed in to
describe the updated values, the API ignores the values of all
fields not covered by the mask.

If a repeated field is specified for an update operation, new values will
be appended to the existing repeated field in the target resource. Note that
a repeated field is only allowed in the last position of a paths string.

If a sub-message is specified in the last position of the field mask for an
update operation, then new value will be merged into the existing sub-message
in the target resource.

For example, given the target message:

f {
b {
d: 1
x: 2
}
c: [1]
}

And an update message:

f {
b {
d: 10
}
c: [2]
}

then if the field mask is:

paths: ["f.b", "f.c"]

then the result will be:

f {
b {
d: 10
x: 2
}
c: [1, 2]
}

An implementation may provide options to override this default behavior for
repeated and message fields.

In order to reset a field's value to the default, the field must
be in the mask and set to the default value in the provided resource.
Hence, in order to reset all fields of a resource, provide a default
instance of the resource and set all fields in the mask, or do
not provide a mask as described below.

If a field mask is not present on update, the operation applies to
all fields (as if a field mask of all fields has been specified).
Note that in the presence of schema evolution, this may mean that
fields the client does not know and has therefore not filled into
the request will be reset to their default. If this is unwanted
behavior, a specific service may require a client to always specify
a field mask, producing an error if not.

As with get operations, the location of the resource which
describes the updated values in the request message depends on the
operation kind. In any case, the effect of the field mask is
required to be honored by the API.

Considerations for HTTP REST

The HTTP kind of an update operation which uses a field mask must
be set to PATCH instead of PUT in order to satisfy HTTP semantics
(PUT must only be used for full updates).

JSON Encoding of Field Masks

In JSON, a field mask is encoded as a single string where paths are
separated by a comma. Fields name in each path are converted
to/from lower-camel naming conventions.

As an example, consider the following message declarations:

message Profile {
User user = 1;
Photo photo = 2;
}
message User {
string display_name = 1;
string address = 2;
}

In proto a field mask for Profile may look as such:

mask {
paths: "user.display_name"
paths: "photo"
}

In JSON, the same mask is represented as below:

{
mask: "user.displayName,photo"
}

Field Masks and Oneof Fields

Field masks treat fields in oneofs just as regular fields. Consider the
following message:

message SampleMessage {
oneof test_oneof {
string name = 4;
SubMessage sub_message = 9;
}
}

The field mask can be:

mask {
paths: "name"
}

Or:

mask {
paths: "sub_message"
}

Note that oneof type names ("test_oneof" in this case) cannot be used in
paths.

Field Mask Verification

The implementation of any API method which has a FieldMask type field in the
request should verify the included field paths, and return an
INVALID_ARGUMENT error if any path is unmappable.

Example

{
  "entity": {
    "before_sid": 0,
    "limit": 0,
    "other_sid": 0
  },
  "mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

entities

array[object (History) {16}]

entities

optional

created_on

string <date-time>

created_on

optional

when the transaction was first opened

Examples:

1s1.000340012s

transfer_start

string <date-time>

transfer_start

optional

when upload of deps is finished and we started moving the files

Examples:

1s1.000340012s

transfer_complete

string <date-time>

transfer_complete

optional

when the record was inserted into the db (delivery ended)

Examples:

1s1.000340012s

origin

enum<string>

origin

optional

the application calling for delivery

Allowed values:

AGENT_APPORGANIZATION_MANAGEMENT_APPCUSTOMER_JOURNEY_SERVICES_APPLIST_MANAGEMENT_SERVICES_APPAGENT_MANAGER_APPNATURAL_LANGUAGE_COMPLIANCE_APPVOICE_ANALYTICS_APPSCRIPTS_APPROOM303_APPOMNI_BOSS_APPWFM_APPPAYMENTS_APPSUPPORT_APPBUSINESS_INTELLIGENCE_APPBACKOFFICE_APPSCORECARDS_APPDEV_TOOLS_APPLEARNING_CENTER_APPDELIVERY_SERVICE_APPPERFORMANCE_MANAGEMENT_APPTICKETS_APPAGENT_BETA_APPNEWSROOM_APPCONTACTMANAGER_APPKNOWLEDGE_BASE_APP

status

enum<string>

status

optional

the status of the delivery

Allowed values:

TRANSFER_STATUS_WAITINGTRANSFER_STATUS_RUNNINGTRANSFER_STATUS_DONE_SUCCESSTRANSFER_STATUS_DONE_PARTIAL_FAILURETRANSFER_STATUS_DONE_TOTAL_FAILURE

transfer_config_name

string

transfer_config_name

optional

delivery_type

string

delivery_type

optional

delivery or retrieval

error

string

error

optional

success

boolean

success

optional

org_id

string

org_id

optional

message_payload

string

message_payload

optional

this should only be the first 64 chars of the message_payload

message_payload_len

integer <int32>

message_payload_len

optional

this represents the full actual length of the message_payload from the frontend

is_inbound

boolean

is_inbound

optional

sid

integer <int64> | string

sid

optional

transfer_config_sid

integer <int64> | string

transfer_config_sid

optional

transaction_sid

integer <int64> | string

transaction_sid

optional

Example

{
  "entities": [
    {
      "created_on": "1s",
      "transfer_start": "1s",
      "transfer_complete": "1s",
      "origin": "AGENT_APP",
      "status": "TRANSFER_STATUS_WAITING",
      "transfer_config_name": "string",
      "delivery_type": "string",
      "error": "string",
      "success": true,
      "org_id": "string",
      "message_payload": "string",
      "message_payload_len": 0,
      "is_inbound": true,
      "sid": 0,
      "transfer_config_sid": 0,
      "transaction_sid": 0
    }
  ]
}

🔴500Server Error

ListHistoryByTransferConfig

Request

Field Masks in Projections

Field Masks in Update Operations

Considerations for HTTP REST

JSON Encoding of Field Masks

Field Masks and Oneof Fields

Field Mask Verification

Request samples

Responses