Skip to content

Describe Resource

workmail_describe_resource R Documentation

Returns the data available for the resource

Description

Returns the data available for the resource.

Usage

workmail_describe_resource(OrganizationId, ResourceId)

Arguments

OrganizationId

[required] The identifier associated with the organization for which the resource is described.

ResourceId

[required] The identifier of the resource to be described.

The identifier can accept ResourceId, Resourcename, or email. The following identity formats are available:

  • Resource ID: r-0123456789a0123456789b0123456789

  • Email address: resource@domain.tld

  • Resource name: resource

Value

A list with the following syntax: 

list(
  ResourceId = "string",
  Email = "string",
  Name = "string",
  Type = "ROOM"|"EQUIPMENT",
  BookingOptions = list(
    AutoAcceptRequests = TRUE|FALSE,
    AutoDeclineRecurringRequests = TRUE|FALSE,
    AutoDeclineConflictingRequests = TRUE|FALSE
  ),
  State = "ENABLED"|"DISABLED"|"DELETED",
  EnabledDate = as.POSIXct(
    "2015-01-01"
  ),
  DisabledDate = as.POSIXct(
    "2015-01-01"
  ),
  Description = "string",
  HiddenFromGlobalAddressList = TRUE|FALSE
)

Request syntax

svc$describe_resource(
  OrganizationId = "string",
  ResourceId = "string"
)