Gets the details of a User Field.
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Rate limits
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
Request parameters
The unique identifier of the Schedule.
The unique identifier of the User Field.
Request headers
A header that makes the request conditional. If the ETag of the requested resource or resource collection matches the provided value, a 304 (Not Modified) response is returned. For more information see the official documentation.
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "userField": { "category": "Task", "color": "#00FFAC", "id": "b923ee62-e02d-486b-81f2-2da64aa8ac3a", "name": "Concrete volume", "type": "Float" } }
Response headers
A header that identifies a specific version of a resource or resource collection. For more information see the official documentation.
Response 304 Not Modified
Not Modified
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the provided User Field or Schedule is not available.
{ "error": { "code": "ScheduleNotFound", "message": "Requested Schedule is not available.", "target": "scheduleId" } }
Response 429 Too many requests
This response indicates that the client sent more requests than allowed by this API for the current tier of the client.
{ "error": { "code": "RateLimitExceeded", "message": "The client sent more requests than allowed by this API for the current tier of the client." } }
Response headers
Number of seconds to wait until client is allowed to make more requests.
User Field
The color of the User Field in the User Field Graph.
The unique identifier of the User Field.
The name of the User Field.
{ "title": "User Field", "type": "object", "properties": { "category": { "$ref": "#/components/schemas/UserFieldCategory", "description": "The category of the User Field." }, "color": { "type": "string", "description": "The color of the User Field in the User Field Graph." }, "id": { "type": "string", "description": "The unique identifier of the User Field." }, "name": { "type": "string", "description": "The name of the User Field." }, "type": { "$ref": "#/components/schemas/UserFieldType", "description": "The type of value that can be assigned to the User Field." } }, "additionalProperties": false }
User Field Category
The category of a User Field describes, what type of object the User Field can be assigned to.
{ "title": "User Field Category", "enum": [ "Task", "Entity3d", "Resource", "ResourceGroup", "Unknown" ], "type": "string", "description": "The category of a User Field describes, what type of object the User Field can be assigned to." }
User Field Response
Container for User Field object.
{ "title": "User Field Response", "type": "object", "properties": { "userField": { "$ref": "#/components/schemas/UserField", "description": "User Field Properties." } }, "additionalProperties": false, "description": "Container for User Field object." }
User Field Type
The type of a User Field describes what type of value can be assigned to the User Field.
{ "title": "User Field Type", "enum": [ "Integer", "String", "StartDate", "FinishDate", "Boolean", "Float", "Unknown" ], "type": "string", "description": "The type of a User Field describes what type of value can be assigned to the User Field." }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?