\ComputerInventoryApi

All URIs are relative to /api

Method	HTTP request	Description
V1ComputersInventoryDetailIdGet	Get /v1/computers-inventory-detail/{id}	Return a Computer details with all sections
V1ComputersInventoryDetailIdPatch	Patch /v1/computers-inventory-detail/{id}	Return a updated computer instance
V1ComputersInventoryGet	Get /v1/computers-inventory	Return a Computer Inventory for paginated list of computers
V1ComputersInventoryIdAttachmentsAttachmentIdDelete	Delete /v1/computers-inventory/{id}/attachments/{attachmentId}	Remove attachment
V1ComputersInventoryIdAttachmentsAttachmentIdGet	Get /v1/computers-inventory/{id}/attachments/{attachmentId}	Download attachment file
V1ComputersInventoryIdAttachmentsPost	Post /v1/computers-inventory/{id}/attachments	Upload attachment and assign to computer
V1ComputersInventoryIdDelete	Delete /v1/computers-inventory/{id}	Remove specified Computer record
V1ComputersInventoryIdGet	Get /v1/computers-inventory/{id}	Return a Computer General details
V1ComputersInventoryIdViewRecoveryLockPasswordGet	Get /v1/computers-inventory/{id}/view-recovery-lock-password	Return a Computers Recovery Lock Password

V1ComputersInventoryDetailIdGet

ComputerInventoryResponse V1ComputersInventoryDetailIdGet(ctx, id).Execute()

Return a Computer details with all sections

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryDetailIdGet(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryDetailIdGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryDetailIdGet`: ComputerInventoryResponse
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryDetailIdGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryDetailIdGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ComputerInventoryResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryDetailIdPatch

ComputerInventoryResponse V1ComputersInventoryDetailIdPatch(ctx, id).ComputerInventoryUpdateRequest(computerInventoryUpdateRequest).Execute()

Return a updated computer instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record
    computerInventoryUpdateRequest := *openapiclient.NewComputerInventoryUpdateRequest() // ComputerInventoryUpdateRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryDetailIdPatch(context.Background(), id).ComputerInventoryUpdateRequest(computerInventoryUpdateRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryDetailIdPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryDetailIdPatch`: ComputerInventoryResponse
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryDetailIdPatch`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryDetailIdPatchRequest struct via the builder pattern

Name	Type	Description	Notes

computerInventoryUpdateRequest | ComputerInventoryUpdateRequest | |

Return type

ComputerInventoryResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryGet

ComputerInventorySearchResults V1ComputersInventoryGet(ctx).Section(section).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()

Return a Computer Inventory for paginated list of computers

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    section := []openapiclient.ComputerSection{openapiclient.ComputerSection("GENERAL")} // []ComputerSection | section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE (optional) (default to ["GENERAL"])
    page := int32(56) // int32 |  (optional) (default to 0)
    pageSize := int32(56) // int32 |  (optional) (default to 100)
    sort := []string{"Inner_example"} // []string | Sorting criteria in the format: `property:asc/desc`. Default sort is `general.name:asc`. Multiple sort criteria are supported and must be separated with a comma.  Fields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.remoteManagement.managementUsername`, `general.mdmCertificateExpiration`, `general.platform`, `hardware.make`, `hardware.model`, `operatingSystem.build`, `operatingSystem.name`, `operatingSystem.version`, `userAndLocation.realname`, `purchasing.lifeExpectancy`, `purchasing.warrantyDate`  Example: `sort=udid:desc,general.name:asc`.  (optional) (default to ["id:asc"])
    filter := "filter_example" // string | Query in the RSQL format, allowing to filter computer inventory collection. Default filter is empty query - returning all results for the requested page.  Fields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`, `general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.lastReportedIp`, `general.remoteManagement.managed`, `general.remoteManagement.managementUsername`, `general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`, `hardware.supportsIosAppInstalls`,`hardware.isAppleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`, `operatingSystem.build`, `operatingSystem.name`, `operatingSystem.version`, `operatingSystem.softwareUpdateDeviceId`, `security.activationLockEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`, `userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`,  This param can be combined with paging and sorting. Example: `filter=general.name==\"Orchard\"`  (optional) (default to "")

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryGet(context.Background()).Section(section).Page(page).PageSize(pageSize).Sort(sort).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryGet`: ComputerInventorySearchResults
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryGet`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryGetRequest struct via the builder pattern

Name	Type	Description	Notes
section	[]ComputerSection	section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE	[default to ["GENERAL"]]
page	int32		[default to 0]
pageSize	int32		[default to 100]
sort	[]string	Sorting criteria in the format: `property:asc/desc`. Default sort is `general.name:asc`. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.remoteManagement.managementUsername`, `general.mdmCertificateExpiration`, `general.platform`, `hardware.make`, `hardware.model`, `operatingSystem.build`, `operatingSystem.name`, `operatingSystem.version`, `userAndLocation.realname`, `purchasing.lifeExpectancy`, `purchasing.warrantyDate` Example: `sort=udid:desc,general.name:asc`.	[default to ["id:asc"]]
filter	string	Query in the RSQL format, allowing to filter computer inventory collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`, `general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`, `general.jamfBinaryVersion`, `general.lastContactTime`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.lastReportedIp`, `general.remoteManagement.managed`, `general.remoteManagement.managementUsername`, `general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`, `hardware.supportsIosAppInstalls`,`hardware.isAppleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`, `operatingSystem.build`, `operatingSystem.name`, `operatingSystem.version`, `operatingSystem.softwareUpdateDeviceId`, `security.activationLockEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`, `userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`, This param can be combined with paging and sorting. Example: `filter=general.name=="Orchard"`	[default to ""]

Return type

ComputerInventorySearchResults

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdAttachmentsAttachmentIdDelete

V1ComputersInventoryIdAttachmentsAttachmentIdDelete(ctx, id, attachmentId).Execute()

Remove attachment

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record
    attachmentId := "attachmentId_example" // string | instance id of attachment object

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdAttachmentsAttachmentIdDelete(context.Background(), id, attachmentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdAttachmentsAttachmentIdDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record
attachmentId	string	instance id of attachment object

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdAttachmentsAttachmentIdDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdAttachmentsAttachmentIdGet

*os.File V1ComputersInventoryIdAttachmentsAttachmentIdGet(ctx, id, attachmentId).Execute()

Download attachment file

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record
    attachmentId := "attachmentId_example" // string | instance id of attachment object

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdAttachmentsAttachmentIdGet(context.Background(), id, attachmentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdAttachmentsAttachmentIdGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryIdAttachmentsAttachmentIdGet`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryIdAttachmentsAttachmentIdGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record
attachmentId	string	instance id of attachment object

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdAttachmentsAttachmentIdGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdAttachmentsPost

HrefResponse V1ComputersInventoryIdAttachmentsPost(ctx, id).File(file).Execute()

Upload attachment and assign to computer

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record
    file := os.NewFile(1234, "some_file") // *os.File | The file to upload

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdAttachmentsPost(context.Background(), id).File(file).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdAttachmentsPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryIdAttachmentsPost`: HrefResponse
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryIdAttachmentsPost`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdAttachmentsPostRequest struct via the builder pattern

Name	Type	Description	Notes

file | *os.File | The file to upload |

Return type

HrefResponse

Authorization

Bearer

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdDelete

V1ComputersInventoryIdDelete(ctx, id).Execute()

Remove specified Computer record

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdDelete(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdGet

ComputerInventoryResponse V1ComputersInventoryIdGet(ctx, id).Section(section).Execute()

Return a Computer General details

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record
    section := []openapiclient.ComputerSection{openapiclient.ComputerSection("GENERAL")} // []ComputerSection | section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&section=hardware (optional) (default to ["GENERAL"])

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdGet(context.Background(), id).Section(section).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryIdGet`: ComputerInventoryResponse
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryIdGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdGetRequest struct via the builder pattern

Name	Type	Description	Notes

section | []ComputerSection | section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&section=hardware | [default to ["GENERAL"]]

Return type

ComputerInventoryResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

V1ComputersInventoryIdViewRecoveryLockPasswordGet

ComputerInventoryRecoveryLockPasswordResponse V1ComputersInventoryIdViewRecoveryLockPasswordGet(ctx, id).Execute()

Return a Computers Recovery Lock Password

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    id := "id_example" // string | instance id of computer record

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ComputerInventoryApi.V1ComputersInventoryIdViewRecoveryLockPasswordGet(context.Background(), id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ComputerInventoryApi.V1ComputersInventoryIdViewRecoveryLockPasswordGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `V1ComputersInventoryIdViewRecoveryLockPasswordGet`: ComputerInventoryRecoveryLockPasswordResponse
    fmt.Fprintf(os.Stdout, "Response from `ComputerInventoryApi.V1ComputersInventoryIdViewRecoveryLockPasswordGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	instance id of computer record

Other Parameters

Other parameters are passed through a pointer to a apiV1ComputersInventoryIdViewRecoveryLockPasswordGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ComputerInventoryRecoveryLockPasswordResponse

Authorization

Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ComputerInventoryApi.md

Latest commit

History

ComputerInventoryApi.md

File metadata and controls

\ComputerInventoryApi

V1ComputersInventoryDetailIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryDetailIdPatch

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdAttachmentsAttachmentIdDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdAttachmentsAttachmentIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdAttachmentsPost

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdDelete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

V1ComputersInventoryIdViewRecoveryLockPasswordGet

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers