/safetyculture-assets | Type: Application | PCID required: Yes
Tools
safetyculture_assets_fields_service_create_field
Create an asset field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Name of the field. |
select_options | any[] | No | — | Optional. The options of a field select. 100 limit enforced in typefield, but to lower the feedback loop, we enforce it here too. |
value_type | string | No | — | ValueType of the field. |
safetyculture_assets_fields_service_delete_field
Delete an asset field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of the field to be deleted. |
safetyculture_assets_fields_service_list_fields
List asset fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
search | string | No | — | Optional. Filter asset fields by this search term. |
safetyculture_assets_fields_service_update_field
Update an asset field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | A global unique identifier for a field. |
field | object | No | — | Field which replaces the one with matching identifier on the server. |
update_mask | string | Yes | — | REQUIRED. The attributes (such as name etc.) you want to update for the field, specified in the parameters. For example, the update_mask=name parameter indicates that only the name will be updated in a request, any other attributes provided in your request body will be ignored. |
safetyculture_assets_service_archive_asset
Archive an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of asset to be archived. |
body | object | Yes | — | The parameters for ArchiveAsset |
safetyculture_assets_service_create_asset
Create an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | Customer specified identifier for the asset. Unique per org. |
fields | any[] | No | — | List of fields based on the type of asset. |
profile_image | object | No | — | An image to be set as profile image. The value of media_type must be MEDIA_TYPE_IMAGE. |
site | string | No | — | Unique ID of site to be associated with asset. |
type_id | string | Yes | — | Global unique identifier of the asset type. |
safetyculture_assets_service_delete_asset
Delete an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of an asset to be deleted. |
safetyculture_assets_service_get_asset
Get full detail information of an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of asset to retrieve. |
safetyculture_assets_service_get_asset_by_code
Get asset by code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | The user-defined unique ID of the asset to retrieve. This ID is user-generated. |
safetyculture_assets_service_list_assets
List assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_filters | any[] | No | — | OPTIONAL. The array of asset filters to apply in your request. You can apply multiple filters in a single request. |
order_by | object | No | — | OPTIONAL. The sorting order for the assets in the response. By default, assets are sorted by creation date from the most recent to the least recent. |
page_size | integer | No | — | OPTIONAL. The number of assets to return. By default, each request returns 50 assets. You can specify a page_size value between 1 to 100. |
page_token | string | No | — | OPTIONAL. The value of next_page_token from a previous response. If specified, the API will return the next batch of results following the previous list assets request. |
search | string | No | — | OPTIONAL. The key words to search for in your request. |
safetyculture_assets_service_lookup_assets_by_field
Lookup assets by a field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_filters | any[] | No | — | OPTIONAL. The array of asset filters to apply in your request. You can apply multiple filters in a single request. |
field_name | string | Yes | — | REQUIRED. The name of the asset field to match. |
order_by | object | No | — | OPTIONAL. The sorting order for the assets in the response. By default, assets are sorted by creation date from the most recent to the least recent. |
page_size | integer | No | — | OPTIONAL. The number of assets to return. By default, each request returns 50 assets. You can specify a page_size value between 1 to 100. |
page_token | string | No | — | OPTIONAL. The value of next_page_token from a previous response. If specified, the API will return the next batch of results following the previous list assets request. |
string_value | string | No | — | REQUIRED. The string value of the asset field to match. |
safetyculture_assets_service_restore_archived_asset
Restore an archived asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of an archived asset to be restored. |
safetyculture_assets_service_update_asset
Update an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique identifier of an asset. This ID is system-generated. |
code | string | No | — | The user-defined unique identifier of an asset. This ID is user-generated. |
created_at | string | No | — | The date created timestamp of an asset. |
fields | any[] | No | — | The associated fields of an asset contained in an array. Each asset’s fields are based on its asset type. Please make sure the asset fields you use associated with the specified asset type. You can retrieve the associated fields using the list type and field association endpoint. |
inspected_at | string | No | — | The date last modified inspection of an asset. |
media | any[] | No | — | All the media directly uploaded to an asset. |
modified_at | string | No | — | The date last modified timetstamp of an asset. |
profile_image | object | No | — | The profile image for an asset. If an asset doesn’t have a profile picture, the API will return nil. |
site | object | No | — | The assigned site of an asset as object. If an asset is not assigned to a site, the API will return nil. |
sourced_from_external_system | boolean | No | — | @deprecated. Use GetAsset API to get the sourced_from_external_system Indicates if an asset is sourced from an external system. |
state | string | No | — | The indicator for whether an asset is active or archived. |
type | object | No | — | The asset type of an asset. |
safetyculture_assets_service_update_asset_location
Update asset location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Unique identifier of the asset. |
location | object | Yes | — | The geometry of the location. |
safetyculture_assets_types_service_create_type
Create an asset type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | REQUIRED. The name you want to set for the asset type. |
safetyculture_assets_types_service_get_type
Get an asset type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Identifier of an asset type to retrieve. |
safetyculture_assets_types_service_list_types
List asset types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | integer | No | — | OPTIONAL. The number of asset types to return. By default, each request returns 50 asset types. You can specify a page_size value between 1 to 100. |
page_token | string | No | — | OPTIONAL. The value of next_page_token from a previous response. If specified, the API will return the next batch of results following the previous list asset types request. |
search | string | No | — | OPTIONAL. The key words to search for in your request. |
type_filters | any[] | No | — | OPTIONAL. The array of asset type filters to apply in your request. You can apply multiple filters in a single request. |
safetyculture_assets_types_service_update_type
Update an asset type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The global unique identifier of the type. |
type | object | No | — | Type which replaces the one with matching identifier on the server. |
update_mask | string | Yes | — | REQUIRED. The attributes (such as name etc.) you want to update for the type, specified in the parameters. For example, the update_mask=name parameter indicates that only the name will be updated in a request, any other attributes provided in your request body will be ignored. |

