Adds a comment to the case timeline.
The ID of the case to add the timeline comment for.
The content of the comment.
- VISIBILITY_ID_INTERNAL: The visibility is internal.
- VISIBILITY_ID_PUBLIC: The visibility is public.
A successful response.
The unique identifier of the timeline entry.
The ID of the case the timeline entry is associated with.
The time when the timeline entry was created.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The unique identifier of the case.
The unique identifier of the case as displayed on the Cases page.
The case title.
The case description.
The name of the state. The default states are: new, in progress, on hold, resolved, closed. If your workspace has custom states, you can specify them by name.
The severity of the case. The possible values are: informational, low, medium, high, critical.
The email address of the case assignee.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The timestamp when the case was created.
The timestamp when the case was last updated.
The timestamp when the case was resolved or closed.
The duration, measured in seconds, from the creation of the case until it should be resolved or closed.
The timestamp when the case was created.
The timestamp when the case was resolved or closed.
The case categpry.
The case tags.
The number of pending tasks.
The reason the case was resolved or closed (up to 100 characters).
The detailed overview of the case resolution.
The case runbook ID.
The unique identifier of the case.
The unique identifier of the case as displayed on the Cases page.
The case title.
The case description.
The name of the state. The default states are: new, in progress, on hold, resolved, closed. If your workspace has custom states, you can specify them by name.
The severity of the case. The possible values are: informational, low, medium, high, critical.
The email address of the case assignee.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The timestamp when the case was created.
The timestamp when the case was last updated.
The timestamp when the case was resolved or closed.
The duration, measured in seconds, from the creation of the case until it should be resolved or closed.
The timestamp when the case was created.
The timestamp when the case was resolved or closed.
The case categpry.
The case tags.
The number of pending tasks.
The reason the case was resolved or closed (up to 100 characters).
The detailed overview of the case resolution.
The case runbook ID.
The unique identifier of the case.
The unique identifier of the case as displayed on the Cases page.
The case title.
The case description.
The name of the state. The default states are: new, in progress, on hold, resolved, closed. If your workspace has custom states, you can specify them by name.
The severity of the case. The possible values are: informational, low, medium, high, critical.
The email address of the case assignee.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The timestamp when the case was created.
The timestamp when the case was last updated.
The timestamp when the case was resolved or closed.
The duration, measured in seconds, from the creation of the case until it should be resolved or closed.
The timestamp when the case was created.
The timestamp when the case was resolved or closed.
The case categpry.
The case tags.
The number of pending tasks.
The reason the case was resolved or closed (up to 100 characters).
The detailed overview of the case resolution.
The case runbook ID.
The fields mask used to update the case.
The text content of the comment added to the case timeline.
The ID of the workflow execution triggered from the case.
The name of the workflow triggered from the case.
The ID of the trigger event.
The ID of the workflow triggered from the case.
The ID of the workflow revision triggered from the case.
The ID of the observable associated with the case.
- TYPE_ID_UNKNOWN: The observable type is unknown.
- TYPE_ID_HOSTNAME: The observable type is Hostname.
- TYPE_ID_IP_ADDRESS: The observable type is IP address.
- TYPE_ID_MAC_ADDRESS: The observable type is MAC address.
- TYPE_ID_USER_NAME: The observable type is User name.
- TYPE_ID_EMAIL_ADDRESS: The observable type is Email.
- TYPE_ID_URL: The observable type is URL.
- TYPE_ID_FILE_NAME: The observable type is File name.
- TYPE_ID_FILE_HASH: The observable type is File hash.
- TYPE_ID_PROCESS_NAME: The observable type is Process name.
- TYPE_ID_RESOURCE_UID: The observable type is Resource UID.
- TYPE_ID_OTHER: The observable type is Other.
The name of the observable type. The name is automatically derived from the type ID.
The ID of the observable disassociated from the case.
- TYPE_ID_UNKNOWN: The observable type is unknown.
- TYPE_ID_HOSTNAME: The observable type is Hostname.
- TYPE_ID_IP_ADDRESS: The observable type is IP address.
- TYPE_ID_MAC_ADDRESS: The observable type is MAC address.
- TYPE_ID_USER_NAME: The observable type is User name.
- TYPE_ID_EMAIL_ADDRESS: The observable type is Email.
- TYPE_ID_URL: The observable type is URL.
- TYPE_ID_FILE_NAME: The observable type is File name.
- TYPE_ID_FILE_HASH: The observable type is File hash.
- TYPE_ID_PROCESS_NAME: The observable type is Process name.
- TYPE_ID_RESOURCE_UID: The observable type is Resource UID.
- TYPE_ID_OTHER: The observable type is Other.
The name of the observable type. The name is automatically derived from the type ID.
The pretty ID of the event attached to the case.
The ID of the event attached to the case.
The time when the event occurred.
- ATTACHABLE_EVENT_TYPE_UNSPECIFIED: The event type is unspecified.
- ATTACHABLE_EVENT_TYPE_INTEGRATION: An integration trigger event.
- ATTACHABLE_EVENT_TYPE_MANUAL: An on-demand trigger event.
- ATTACHABLE_EVENT_TYPE_SCHEDULE: A scheduled trigger event.
- ATTACHABLE_EVENT_TYPE_NESTED: A nested workflow trigger event.
- ATTACHABLE_EVENT_TYPE_STEPS: A single step execution event.
- ATTACHABLE_EVENT_TYPE_INTERNAL: A system event.
The name of the event.
The key of the custom field.
The ID of the case to which the custom field applies.
The value of the custom field.
The custom field type enum.
- TYPE_UNSPECIFIED: The custom field value type is unspecified.
- TYPE_SHORT_TEXT: The custom field value type is text.
- TYPE_NUMBER: The custom field value type is number.
- TYPE_BOOLEAN: The custom field value type is boolean.
- TYPE_TIMESTAMP: The custom field value type is timestamp.
- TYPE_LIST_SINGLE_SELECT: The custom field value type is list single select.
The constraints applied to the custom field value if the type is TYPE_SHORT_TEXT.
The minimum length of the custom field value.
The maximum length of the custom field value.
The regular expression that the custom field value must match.
The constraints applied to the custom field value if the type is TYPE_LIST_SINGLE_SELECT.
The list of acceptable values for the custom field.
The key of the custom field.
The ID of the case to which the custom field applies.
The value of the custom field.
The custom field type enum.
- TYPE_UNSPECIFIED: The custom field value type is unspecified.
- TYPE_SHORT_TEXT: The custom field value type is text.
- TYPE_NUMBER: The custom field value type is number.
- TYPE_BOOLEAN: The custom field value type is boolean.
- TYPE_TIMESTAMP: The custom field value type is timestamp.
- TYPE_LIST_SINGLE_SELECT: The custom field value type is list single select.
The constraints applied to the custom field value if the type is TYPE_SHORT_TEXT.
The minimum length of the custom field value.
The maximum length of the custom field value.
The regular expression that the custom field value must match.
The constraints applied to the custom field value if the type is TYPE_LIST_SINGLE_SELECT.
The list of acceptable values for the custom field.
The unique identifier of the user input task.
The name of the user input task.
The ID of the workflow execution in which the user input task was assigned to the case.
The timestamp when the user input task was assigned.
The timestamp when the user input task was last updated.
- STATE_UNSPECIFIED: STATE_UNSPECIFIED
- STATE_PENDING: STATE_PENDING
- STATE_RESPONDED: STATE_RESPONDED
- STATE_TIMED_OUT: STATE_TIMED_OUT
The ID of the case the user input task was assigned to.
The ID of the workflow during the execution of which the user input task was assigned.
The ID that is used to access the form in the app.
The unique identifier of the user input task.
The name of the user input task.
The ID of the workflow execution in which the user input task was assigned to the case.
The timestamp when the user input task was assigned.
The timestamp when the user input task was last updated.
- STATE_UNSPECIFIED: STATE_UNSPECIFIED
- STATE_PENDING: STATE_PENDING
- STATE_RESPONDED: STATE_RESPONDED
- STATE_TIMED_OUT: STATE_TIMED_OUT
The ID of the case the user input task was assigned to.
The ID of the workflow during the execution of which the user input task was assigned.
The ID that is used to access the form in the app.
The unique identifier of the user input task.
The name of the user input task.
The ID of the workflow execution in which the user input task was assigned to the case.
The timestamp when the user input task was assigned.
The timestamp when the user input task was last updated.
- STATE_UNSPECIFIED: STATE_UNSPECIFIED
- STATE_PENDING: STATE_PENDING
- STATE_RESPONDED: STATE_RESPONDED
- STATE_TIMED_OUT: STATE_TIMED_OUT
The ID of the case the user input task was assigned to.
The ID of the workflow during the execution of which the user input task was assigned.
The ID that is used to access the form in the app.
The ID of the first case in the link. Provide a value for this field when creating, updating or deleting a link.
The ID of the second case in the link. Provide a value for this field when creating, updating or deleting a link.
The link description. This field is optional.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time when the link was created. This field value is automatically generated.
The time when the link was updated. Only the link relations can be updated; this field value is automatically generated.
The relation of the first case to the second case. Provide a value for this field when creating or updating a link. The possible values are: parent_of/child_of, duplicate_of/duplicate_by, blocking/blocked_by, or other.
The relation of the second case to the first case. Provide a value for this field when creating or updating a link. The value should complement the first_case_relation field value; for instance, if the first_case_relation is set to parent_of, the second_case_relation value should be child_of.
The ID of the first case in the link. Provide a value for this field when creating, updating or deleting a link.
The ID of the second case in the link. Provide a value for this field when creating, updating or deleting a link.
The link description. This field is optional.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time when the link was created. This field value is automatically generated.
The time when the link was updated. Only the link relations can be updated; this field value is automatically generated.
The relation of the first case to the second case. Provide a value for this field when creating or updating a link. The possible values are: parent_of/child_of, duplicate_of/duplicate_by, blocking/blocked_by, or other.
The relation of the second case to the first case. Provide a value for this field when creating or updating a link. The value should complement the first_case_relation field value; for instance, if the first_case_relation is set to parent_of, the second_case_relation value should be child_of.
The ID of the first case in the link. Provide a value for this field when creating, updating or deleting a link.
The ID of the second case in the link. Provide a value for this field when creating, updating or deleting a link.
The link description. This field is optional.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time when the link was created. This field value is automatically generated.
The time when the link was updated. Only the link relations can be updated; this field value is automatically generated.
The relation of the first case to the second case. Provide a value for this field when creating or updating a link. The possible values are: parent_of/child_of, duplicate_of/duplicate_by, blocking/blocked_by, or other.
The relation of the second case to the first case. Provide a value for this field when creating or updating a link. The value should complement the first_case_relation field value; for instance, if the first_case_relation is set to parent_of, the second_case_relation value should be child_of.
The ID of the first case in the link. Provide a value for this field when creating, updating or deleting a link.
The ID of the second case in the link. Provide a value for this field when creating, updating or deleting a link.
The link description. This field is optional.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time when the link was created. This field value is automatically generated.
The time when the link was updated. Only the link relations can be updated; this field value is automatically generated.
The relation of the first case to the second case. Provide a value for this field when creating or updating a link. The possible values are: parent_of/child_of, duplicate_of/duplicate_by, blocking/blocked_by, or other.
The relation of the second case to the first case. Provide a value for this field when creating or updating a link. The value should complement the first_case_relation field value; for instance, if the first_case_relation is set to parent_of, the second_case_relation value should be child_of.
The pretty ID of the event attached to the case.
The ID of the event attached to the case.
The time when the event occurred.
- ATTACHABLE_EVENT_TYPE_UNSPECIFIED: The event type is unspecified.
- ATTACHABLE_EVENT_TYPE_INTEGRATION: An integration trigger event.
- ATTACHABLE_EVENT_TYPE_MANUAL: An on-demand trigger event.
- ATTACHABLE_EVENT_TYPE_SCHEDULE: A scheduled trigger event.
- ATTACHABLE_EVENT_TYPE_NESTED: A nested workflow trigger event.
- ATTACHABLE_EVENT_TYPE_STEPS: A single step execution event.
- ATTACHABLE_EVENT_TYPE_INTERNAL: A system event.
The name of the event.
The ID of the note.
The ID of the case.
The title of the note.
The content of the note.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time the note was created.
The time the note was last updated.
The ID of the note.
The ID of the case.
The title of the note.
The content of the note.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time the note was created.
The time the note was last updated.
The ID of the note.
The ID of the case.
The title of the note.
The content of the note.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time the note was created.
The time the note was last updated.
The ID of the note.
The ID of the case.
The title of the note.
The content of the note.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The actor kind. Supported values are: USER, WORKFLOW, SOCRATES.
The email of the actor. Only applicable when the actor is a user.
The time the note was created.
The time the note was last updated.
The name of the custom SLA timer.
The ID of the case to which the custom SLA timer applies.
The case workspace ID. Default is the current workspace.
The duration, in seconds, from the timer start until expiration.
The state of the custom SLA timer.
- STATE_ID_NOT_RUNNING: The custom SLA timer isn't running.
- STATE_ID_RUNNING: The custom SLA timer is running.
The name of the timer state.
Indicates whether the timer is a lead timer.
The timestamp when the custom SLA timer was created.
The elapsed time of the custom SLA timer.
The name of the custom SLA timer.
The ID of the case to which the custom SLA timer applies.
The case workspace ID. Default is the current workspace.
The duration, in seconds, from the timer start until expiration.
The state of the custom SLA timer.
- STATE_ID_NOT_RUNNING: The custom SLA timer isn't running.
- STATE_ID_RUNNING: The custom SLA timer is running.
The name of the timer state.
Indicates whether the timer is a lead timer.
The timestamp when the custom SLA timer was created.
The elapsed time of the custom SLA timer.
The fields mask used to update the case.
- VISIBILITY_ID_INTERNAL: The visibility is internal.
- VISIBILITY_ID_PUBLIC: The visibility is public.
The visibility value. The value is automatically derived from the visibility ID.
Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.
You don't have permission to access this resource.
An unexpected error response.
Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo))
Example 2: Pack and unpack a message in Java.
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) // or ... if (any.isSameTypeAs(Foo.getDefaultInstance()))
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo any, err := anypb.New(foo) if err != nil ... foo := &pb.Foo if err := any.UnmarshalTo(foo); err != nil
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON
The JSON representation of an Any value uses the regular
representation of the deserialized, embedded message, with an
additional field @type which contains the type URL. Example:
package google.profile; message Person
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName":
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value which holds the custom JSON in addition to the @type
field. Example (for message [google.protobuf.Duration][]):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
A URL/resource name that uniquely identifies the type of the serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
path/google.protobuf.Duration). The name should be in a canonical form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they
expect it to use in the context of Any. However, for URLs which use the
scheme http, https, or no scheme, one can optionally set up a type
server that maps type URLs to message definitions as follows:
- If no scheme is provided,
httpsis assumed. - An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
- Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be
used with implementation specific semantics.