Class DataRequest

Namespace

Autodesk.ACC.DataConnector.Models

Assembly

Autodesk.ACC.DataConnector.dll

public class DataRequest : IAdditionalDataHolder, IParsable

Inheritance

object

DataRequest

Implements

IAdditionalDataHolder

IParsable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DataRequest()

Instantiates a new DataRequest and sets the default values.

public DataRequest()

Properties

AccountId

The account ID

public Guid? AccountId { get; set; }

Property Value

Guid?

AdditionalData

Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

public IDictionary<string, object> AdditionalData { get; set; }

Property Value

IDictionary<string, object>

CallbackUrl

The callback URL specified for the data request

public string? CallbackUrl { get; set; }

Property Value

string

CreatedAt

The date and time the data request was created (ISO 8601)

public DateTimeOffset? CreatedAt { get; set; }

Property Value

DateTimeOffset?

CreatedBy

The BIM 360 / ACC user ID of the user who created the data request

public string? CreatedBy { get; set; }

Property Value

string

CreatedByEmail

The email address of the user who created the data request

public string? CreatedByEmail { get; set; }

Property Value

string

DateRange

The timeframe used for extracting data in the request

public DataRequest_dateRange? DateRange { get; set; }

Property Value

DataRequest_dateRange?

Description

The user-entered description of this data request

public string? Description { get; set; }

Property Value

string

EffectiveFrom

The date and time when a one-time job execution or a recurring interval schedule begins (ISO 8601)

public DateTimeOffset? EffectiveFrom { get; set; }

Property Value

DateTimeOffset?

EffectiveTo

The date and time when the recurring interval schedule ends (ISO 8601)

public DateTimeOffset? EffectiveTo { get; set; }

Property Value

DateTimeOffset?

EndDate

The end date and time for the data extraction (ISO 8601)

public DateTimeOffset? EndDate { get; set; }

Property Value

DateTimeOffset?

Id

The ID of the data request

public Guid? Id { get; set; }

Property Value

Guid?

IsActive

The data request's active/inactive status

public bool? IsActive { get; set; }

Property Value

bool?

LastQueuedAt

The date and time the last job for this data request was scheduled to execute (ISO 8601)

public DateTimeOffset? LastQueuedAt { get; set; }

Property Value

DateTimeOffset?

ProjectId

(Legacy) A single project ID for the data request. Superseded by projectIdList

public Guid? ProjectId { get; set; }

Property Value

Guid?

ProjectIdList

A list of up to 50 project IDs included in the data request

public List<string>? ProjectIdList { get; set; }

Property Value

List<string>

ProjectStatus

The types of projects to be included in a request

public DataRequest_projectStatus? ProjectStatus { get; set; }

Property Value

DataRequest_projectStatus?

ReoccuringInterval

The number of scheduleInterval units to wait between job execution

public int? ReoccuringInterval { get; set; }

Property Value

int?

ScheduleInterval

The scheduling interval unit for jobs spawned by this data request

public DataRequest_scheduleInterval? ScheduleInterval { get; set; }

Property Value

DataRequest_scheduleInterval?

SendEmail

Send a notification email to the user upon job completion

public bool? SendEmail { get; set; }

Property Value

bool?

ServiceGroups

The service groups from which data has been extracted

public List<string>? ServiceGroups { get; set; }

Property Value

List<string>

StartDate

The start date and time for the data extraction (ISO 8601)

public DateTimeOffset? StartDate { get; set; }

Property Value

DateTimeOffset?

UpdatedAt

The date and time the data request was last updated (ISO 8601)

public DateTimeOffset? UpdatedAt { get; set; }

Property Value

DateTimeOffset?

UpdatedBy

The BIM 360 / ACC user ID of the user who last updated the data request

public string? UpdatedBy { get; set; }

Property Value

string

Methods

CreateFromDiscriminatorValue(IParseNode)

Creates a new instance of the appropriate class based on discriminator value

public static DataRequest CreateFromDiscriminatorValue(IParseNode parseNode)

Parameters

parseNode IParseNode

The parse node to use to read the discriminator value and create the object

Returns

DataRequest

A DataRequest

GetFieldDeserializers()

The deserialization information for the current model

public virtual IDictionary<string, Action<IParseNode>> GetFieldDeserializers()

Returns

IDictionary<string, Action<IParseNode>>

A IDictionary<string, Action<IParseNode>>

Serialize(ISerializationWriter)

Serializes information the current object

public virtual void Serialize(ISerializationWriter writer)

Parameters

writer ISerializationWriter

Serialization writer to use to serialize this model