Custom fields

• Asset types
  • getGet asset type
  • getGet asset types
• Custom field values
  • getGet custom field values
  • postAdd custom field value
  • getGet custom field value
  • putReplace custom field value
  • delDelete custom field value
• Custom fields
  • getGet custom fields
  • postAdd custom field
  • getGet custom field
  • putReplace custom field
  • delDelete custom field
• Data types
  • getGet data types
  • getGet data type

API docs by Redocly

SAM: Custom fields (0.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with custom fields.

Asset types

Get asset type

Returns the details of a given asset type.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the asset type.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-asset-types/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
• "name": "A name",
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get asset types

Returns a collection of asset types.

Authorizations:

BearerAuth

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-asset-types

Response samples

• 200
• 403
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
    • "name": "A name"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Custom field values

Get custom field values

Returns a collection of customfield values.

Authorizations:

BearerAuth

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-values

Response samples

• 200
• 403
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
    • "customFieldId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
    • "customFieldName": "Some name",
    • "assetId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
    • "assetType": {

      • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
      • "name": "A name"

      },
    • "value": "A value"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  }

}

Add custom field value

Creates a custom field value.

Authorizations:

BearerAuth

Request Body schema: application/json

customFieldId required	string <guid> non-empty The unique ID of the custom field.
assetId required	string <guid> non-empty The unique ID of the asset.
assetTypeId required	string <guid> non-empty The unique ID of the asset type.
value required	string non-empty Custom field value.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-values

Request samples

• Payload

Content type

application/json

{

• "customFieldId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "assetId": "34469e92-5132-4269-8392-ef0b7652833f",
• "assetTypeId": "efdd2bd1-4d22-42f9-b3cd-dffda7374ad9",
• "value": "A value"

}

Response samples

• 201
• 400
• 403
• 500

Content type

application/json

{

• "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e"

}

Get custom field value

Returns the details of a given customfield value.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field value.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-values/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "customFieldId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "customFieldName": "Some name",
• "assetId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "assetType": {

  • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
  • "name": "A name"

  },
• "value": "A value",
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Replace custom field value

Replaces a custom field value.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field value.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-values/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0"

}

Delete custom field value

Removes the given custom field value.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field value.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-values/{id}

Response samples

• 400
• 403
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 0,
  • "message": "string"

  }

}

Custom fields

Get custom fields

Returns a collection of customfields.

Authorizations:

BearerAuth

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields

Response samples

• 200
• 403
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
    • "name": "A name",
    • "description": "A long description.",
    • "isRequired": false,
    • "defaultValue": "A default value",
    • "isMultipleChoice": false,
    • "multipleChoice": {

      • "0": "Value 1",
      • "1": "Value 2"

      },
    • "assetTypes": [

      • {

        • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
        • "name": "A name"

        }

      ],
    • "dataType": {

      • "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
      • "name": "A name"

      }

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Add custom field

Creates a custom field.

Authorizations:

BearerAuth

Request Body schema: application/json

name required	string non-empty Custom field name.
description	string Custom field description.
dataTypeId required	string <guid> non-empty The unique ID of the data type.
assetTypesIds required	Array of strings <guid> [ items <guid > ] Collection of asset type ids.
isRequired	boolean true if required; otherwise, false.
defaultValue	string or null Default value of custom field.
multipleChoice	Array of strings Collection of choices.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields

Request samples

• Payload

Content type

application/json

{

• "name": "Field 1",
• "description": "Some long description.",
• "dataTypeId": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "assetTypesIds": {

  • "0": "34469e92-5132-4269-8392-ef0b7652833f"

  },
• "isRequired": true,
• "defaultValue": "A value",
• "multipleChoice": {

  • "0": "Choice 1",
  • "1": "Choice 2"

  }

}

Response samples

• 201
• 400
• 403
• 500

Content type

application/json

{

• "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e"

}

Get custom field

Returns the details of a given customfield.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
• "name": "A name",
• "description": "A long description.",
• "isRequired": false,
• "defaultValue": "A default value",
• "isMultipleChoice": false,
• "multipleChoice": {

  • "0": "Value 1",
  • "1": "Value 2"

  },
• "assetTypes": [

  • {

    • "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
    • "name": "A name"

    }

  ],
• "dataType": {

  • "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
  • "name": "A name"

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Replace custom field

Replaces a custom field.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0"

}

Delete custom field

Removes the given custom field.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom field.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields/{id}

Response samples

• 400
• 403
• 404
• 500

Content type

application/json

{

• "error": {

  • "code": 0,
  • "message": "string"

  }

}

Data types

Get data types

Returns a collection of data types.

Authorizations:

BearerAuth

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-data-types

Response samples

• 200
• 403
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
    • "name": "A name"

    }

  ],
• "pagination": {

  • "page_size": 25,
  • "page_number": 1,
  • "total_pages": 5,
  • "total_items": 100

  },
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get data type

Returns the details of a given data type.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the data type.

Responses

https://{region}.snowsoftware.io/api/custom-fields/v1/custom-fields-data-types/{id}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "id": "ab3263e4-a4dc-483e-ab4b-3ddd298f558e",
• "name": "A name",
• "_links": [

  • {

    • "href": "/api/custom-fields/v1/custom-fields",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}