Custom fields

• Custom-Fields
  • patchUpdate custom field values
  • getGet custom fields

API docs by Redocly

SaaS: Custom fields (1.0.1)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SaaS Custom fields.

Custom-Fields

Update custom field values

Modifies one or more custom field values for the given resource.

Authorizations:

bearerAuthbearerAuth

Request Body schema: application/merge-patch+json

id required	string The unique ID of the resource.
saasCategory required	string Enum Description Application Update operation is performed for the application ID provided. Subscription Update operation is performed for the subscription ID provided. User Update operation is performed for the user ID provided. The category of the custom field.
required	Array of objects (Custom Field Object) The values of custom fields.
Array name required string The name of the custom field. value required string The value assigned to the custom field. dataType string The data type of the custom field. currencyCode string The code representing the currency used in monetary custom fields.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v2/custom-fields/values

Request samples

• Payload

Content type

application/merge-patch+json

{

• "id": "483c67cf-e247-4a82-bef7-b86a29560788",
• "saasCategory": "Application",
• "customFields": [

  • {

    • "name": "color",
    • "value": "string",
    • "dataType": "string",
    • "currencyCode": "EUR"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "tenantId": "2f86b198-04f3-4770-ad08-b32518206da0",
• "saasCategory": "User",
• "objectID": "483c67cf-e247-4a82-bef7-b86a29560788",
• "customFields": [

  • {

    • "name": "color",
    • "value": "string",
    • "dataType": "string",
    • "currencyCode": "EUR"

    }

  ],
• "requesterId": "483c67cf-e247-4a82-bef7-b86a29560788"

}

Get custom fields

Returns a collection of custom fields.

Authorizations:

bearerAuthbearerAuth

query Parameters

filter	string Example: filter=?filter='SaaSCategory -eq Application' For more information on the available operators and which data types those operators work on, see Filter API call results.
page_number	integer <int32> Default: 1 The page number.
page_size	integer <int32> Default: 100 The maximum number of items in the response.
sort	string Example: sort=?sort=field1:asc For more information on sorting capability and examples, see Sort API call results.

Responses

https://{region}.snowsoftware.io/api/saas/consolidated-view/v2/custom-fields

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "pagination": {

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

  },
• "items": [

  • {

    • "id": "2f86b198-04f3-4770-ad08-b32518206da0",
    • "dataType": "string",
    • "predefinedValues": {

      • "0": "blue",
      • "1": "red",
      • "2": "yellow"

      },
    • "saasCategory": "saas-users",
    • "defaultValue": "blue",
    • "fieldName": "color",
    • "isCurrency": true

    }

  ]

}