IPWorks Cloud 2020 .NET Edition

Questions / Feedback?

BoxMetadata Type

A Box metadata item.

Remarks

This type represents a Box metadata item.

Fields

ContainerSchema
String

The schema of the metadata item's container.

This field specifies the metadata of the schema item's container.

ContainerScope
String

The scope that the metadata item's container resides in.

This field specifies the scope that the metadata item's container resides in.

ModOp
BoxMetadataModOps

The modification operation to perform on the metadata item.

This field specifies which modification operation should be performed for the metadata item when UpdateMetadata is called. Possible values are:

0 (opNone - default) No-Op (the component skips the metadata item).
1 (opAdd) A new metadata item will be added. If one already exists with the specified Name, its value will be overwritten.
2 (opReplace) The metadata item with the given Name (which must already exist) will have its value overwritten.
3 (opCopyFrom) A new metadata item will be added, its value copied from the item specified by SourceName (which must already exist).
4 (opMoveFrom) A new metadata item will be added, its value moved from the item specified by SourceName (which must already exist). The source item will then be removed.
5 (opRemove) The metadata item with the given Name (which must already exist) will be removed.
6 (opTest) Will verify that the metadata item with the given Name (which must already exist) has the specified Value.

Refer to UpdateMetadata for more information.

Name
String

The name of the metadata item.

This field specifies the name of the metadata item. It cannot begin with the $ character.

This field may be used as input when CreateMetadata or UpdateMetadata is called.

ResourceId
String

The Id of the resource the metadata item is associated with.

This field specifies the Id of the resource the metadata item is associated with.

SourceName
String

The name of another metadata item from which to copy or move a value.

This field specifies the name of another metadata item whose value should be copied or moved to this one. It cannot begin with the $ character.

This field may be used as input when UpdateMetadata is called if the ModOp field is set to one of the following:

  • 3 (opCopyFrom)
  • 4 (opMoveFrom)

Value
String

The value of the metadata item.

This field specifies the value of the metadata item.

This field may be used as input when CreateMetadata or UpdateMetadata is called if the ModOp field is set to one of the following:

  • 1 (opAdd)
  • 2 (opReplace)
  • 6 (opTest)

When this field's value is sent to the server, it is encoded according to the ValueType field.

ValueType
BoxMetadataTypes

The type of the metadata item's value.

This field specifies the type of the metadata item's value, and controls how the component encodes Value when submitting it to the server. Possible values, and their corresponding Box types, are:

Value Type Encoded As Corresponding Box Types
0 (mtString - default) String string, date, enum (single-select)
1 (mtNumber) Number float (note: actually any numeric value, including integers)
2 (mtMultiSelect) Array of strings enum (multi-select)

The Value field should hold a comma-separated list of strings when this field is set to 2 (mtMultiSelect).

This field may be used as input when CreateMetadata or UpdateMetadata is called if the ModOp field is set to one of the following:

  • 1 (opAdd)
  • 2 (opReplace)
  • 6 (opTest)

Important: Box only allows string-typed metadata items in the /global/properties metadata container; the component will always ignore this field and encode metadata items as strings when creating or updating the /global/properties container.

Constructors

public BoxMetadata();
Public BoxMetadata()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 .NET Edition - Version 20.0 [Build 8265]