Class WithParameterItemRequestBuilder

Namespace

Autodesk.ACC.ModelProperties.V2.Projects.Item.CustomProperties.Parameters.Item

Assembly

Autodesk.ACC.ModelProperties.dll

Builds and executes requests for operations under \v2\projects{projectId}\custom-properties\parameters{parameterId}

public class WithParameterItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

WithParameterItemRequestBuilder

Inherited Members

BaseRequestBuilder.PathParameters

BaseRequestBuilder.RequestAdapter

BaseRequestBuilder.UrlTemplate

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WithParameterItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithParameterItemRequestBuilder and sets the default values.

public WithParameterItemRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)

Parameters

pathParameters Dictionary<string, object>

Path parameters for the request

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

WithParameterItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithParameterItemRequestBuilder and sets the default values.

public WithParameterItemRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)

Parameters

rawUrl string

The raw URL to use for the request builder.

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

Methods

DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

The specified Parameter from the Parameter Service will no longer be available as a Custom Property on the project.The underlying data storage for the Custom Property is not deleted during this call, but could bedeleted at a later time, for example the next time a Lineage's Index is re-generated. Once theunderlying data is deleted there is no way to restore it.

public Task DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task

Exceptions

ResourceError

When receiving a 401 status code

ResourceError

When receiving a 404 status code

GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Read the given single Parameter that has been importad into the project as a Custom Property.

public Task<Stream?> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<Stream>

A Stream

Exceptions

ResourceError

When receiving a 404 status code

PutAsync(Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Import a Parameter into a Project as a Custom Property. All lineages in the Project will havethe imported Custom Property.## Assigning Properties to Design ElementsCustom Properties can only be assigned/scoped to individual Design Elements by Revit Category.The Revit Categories for a Custom Property's corresponding Parameter can be configured in theParameter Service as the "category binding".## Links- Custom Properties and Parameter Service- Parameter Service- Parameter Service API- Forge Data Schema- Forge Data Schema Specification - V2## Open Questions- For AIM, do Parameters need to be in Parameter Svc, or Forge Data Schema, or both?- Can Forge Data Schema parameters be edited? Or does it require a new version?- How do we store "display units" for Custom Properties?- Does AIM store Parameters (properties) in "storage units"?- Permission model: who is allowed to add a new CP to a project? only a project admin? Param Svc currently allows only account admins to create new Params, but Custom Props requires more open permissions. This is a recognized gap that is being worked out between Model Quality Group and PSET PMs.- Parameter Service is currently in beta, when is it supposed to be released?It could be useful for invalidating an index to query the Param Svc for the "last modified" time on acollection, which is the last time the collection itself or any of its individual params was modified.

public Task<Stream?> PutAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<Stream>

A Stream

Exceptions

ResourceError

When receiving a 404 status code

ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

The specified Parameter from the Parameter Service will no longer be available as a Custom Property on the project.The underlying data storage for the Custom Property is not deleted during this call, but could bedeleted at a later time, for example the next time a Lineage's Index is re-generated. Once theunderlying data is deleted there is no way to restore it.

public RequestInformation ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Read the given single Parameter that has been importad into the project as a Custom Property.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPutRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Import a Parameter into a Project as a Custom Property. All lineages in the Project will havethe imported Custom Property.## Assigning Properties to Design ElementsCustom Properties can only be assigned/scoped to individual Design Elements by Revit Category.The Revit Categories for a Custom Property's corresponding Parameter can be configured in theParameter Service as the "category binding".## Links- Custom Properties and Parameter Service- Parameter Service- Parameter Service API- Forge Data Schema- Forge Data Schema Specification - V2## Open Questions- For AIM, do Parameters need to be in Parameter Svc, or Forge Data Schema, or both?- Can Forge Data Schema parameters be edited? Or does it require a new version?- How do we store "display units" for Custom Properties?- Does AIM store Parameters (properties) in "storage units"?- Permission model: who is allowed to add a new CP to a project? only a project admin? Param Svc currently allows only account admins to create new Params, but Custom Props requires more open permissions. This is a recognized gap that is being worked out between Model Quality Group and PSET PMs.- Parameter Service is currently in beta, when is it supposed to be released?It could be useful for invalidating an index to query the Param Svc for the "last modified" time on acollection, which is the last time the collection itself or any of its individual params was modified.

public RequestInformation ToPutRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

WithUrl(string)

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

public WithParameterItemRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WithParameterItemRequestBuilder

A WithParameterItemRequestBuilder