Custom objects

• Custom object types
  • getGet properties
  • getGet property
  • getGet custom object types
  • getGet custom object type
• Custom objects
  • getGet custom objects
  • getGet custom object
• Custom objects properties
  • getGet property values
  • getGet property value

API docs by Redocly

SAM: Custom objects (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with custom objects.

Custom object types

Get properties

Returns a collection of properties for a given custom object type.

Authorizations:

BearerAuth

path Parameters

typeid required

string The unique ID of the custom object type.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjecttypes/{typeid}/properties

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "08163a8f-b032-4174-9a24-f339b1fdda53",
    • "typeId": "2b5e364c-ae69-4008-ae8d-e3009106f7c4",
    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ]

    }

  ],
• "pagination": {

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

  },
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get property

Returns the details of a given property for a given custom object type.

Authorizations:

BearerAuth

path Parameters

typeid required	string The unique ID of the custom object type.
propertyid required	string The unique Id of the property.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjecttypes/{typeid}/properties/{propertyid}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "08163a8f-b032-4174-9a24-f339b1fdda53",
• "typeId": "2b5e364c-ae69-4008-ae8d-e3009106f7c4",
• "name": "Property 1",
• "description": "The first property",
• "isMandatory": true,
• "defaultValue": "Test value",
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get custom object types

Returns a collection of custom object types.

Authorizations:

BearerAuth

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjecttypes

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "9e10a6c2-f6f8-4c27-b0d8-3af23a5dff74",
    • "name": "Custom object type 1",
    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ]

    }

  ],
• "pagination": {

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

  },
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get custom object type

Returns the details of a given custom object type.

Authorizations:

BearerAuth

path Parameters

typeid required

string The unique ID of the custom object type.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjecttypes/{typeid}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "9e10a6c2-f6f8-4c27-b0d8-3af23a5dff74",
• "name": "Custom object type 1",
• "description": "The first custom object type",
• "canAttachToContract": true,
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Custom objects

Get custom objects

Returns a collection of custom objects.

Authorizations:

BearerAuth

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjects

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "1a2c3e83-4247-4b99-af92-fefacb825720",
    • "objectName": "Custom Object 1",
    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ]

    }

  ],
• "pagination": {

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

  },
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get custom object

Returns the details of a given custom object.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom object.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjects/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "1a2c3e83-4247-4b99-af92-fefacb825720",
• "objectName": "Custom Object 1",
• "computerId": "15764003-3c61-4d5f-9839-a63271240519",
• "userId": "c9091484-a226-4b36-b1e1-250fe0757537",
• "createdDate": "2019-08-24T14:15:22Z",
• "updatedDate": "2019-08-24T14:15:22Z",
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Custom objects properties

Get property values

Returns a collection of property values for a given custom object.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the custom object.

query Parameters

page_size	integer <= 1000 Default: 100 The maximum number of items in the response.
page_number	integer <int64> Default: 1 The page number.
filter	string Example: filter=status -eq "active" For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjects/{id}/propertyvalues

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "id": "768d6f78-6c87-490e-b7b0-d2fa74e3dd0f",
    • "objectId": "1a2c3e83-4247-4b99-af92-fefacb825720",
    • "_links": [

      • {

        • "href": "api/sam/estate/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ]

    }

  ],
• "pagination": {

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

  },
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get property value

Returns the details of a given property value for a given custom object.

Authorizations:

BearerAuth

path Parameters

id required	string The unique ID of the custom object.
valueId required	string The unique ID of the property value.

Responses

https://{region}.snowsoftware.io/api/sam/estate/v1/customobjects/{id}/propertyvalues/{valueId}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "768d6f78-6c87-490e-b7b0-d2fa74e3dd0f",
• "propertyId": "08163a8f-b032-4174-9a24-f339b1fdda53",
• "objectId": "1a2c3e83-4247-4b99-af92-fefacb825720",
• "value": "Test",
• "_links": [

  • {

    • "href": "api/sam/estate/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}