Skip to content

Batch Get Field

connectcases_batch_get_field R Documentation

Returns the description for the list of fields in the request parameters

Description

Returns the description for the list of fields in the request parameters.

Usage

connectcases_batch_get_field(domainId, fields)

Arguments

domainId

[required] The unique identifier of the Cases domain.

fields

[required] A list of unique field identifiers.

Value

A list with the following syntax:

list(
  fields = list(
    list(
      fieldId = "string",
      name = "string",
      fieldArn = "string",
      description = "string",
      type = "Text"|"Number"|"Boolean"|"DateTime"|"SingleSelect"|"Url"|"User",
      namespace = "System"|"Custom",
      tags = list(
        "string"
      ),
      deleted = TRUE|FALSE,
      createdTime = as.POSIXct(
        "2015-01-01"
      ),
      lastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      attributes = list(
        text = list(
          isMultiline = TRUE|FALSE
        )
      )
    )
  ),
  errors = list(
    list(
      id = "string",
      errorCode = "string",
      message = "string"
    )
  )
)

Request syntax

svc$batch_get_field(
  domainId = "string",
  fields = list(
    list(
      id = "string"
    )
  )
)