\OwnerContentAPI

All URIs are relative to /candlepin

Method	HTTP request	Description
CreateContent	Post /owners/{owner_key}/content
CreateContentBatch	Post /owners/{owner_key}/content/batch
GetContentById	Get /owners/{owner_key}/content/{content_id}
GetContentsByOwner	Get /owners/{owner_key}/content
RemoveContent	Delete /owners/{owner_key}/content/{content_id}
UpdateContent	Put /owners/{owner_key}/content/{content_id}

CreateContent

ContentDTO CreateContent(ctx, ownerKey).ContentDTO(contentDTO).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | The key of the owner
	contentDTO := *openapiclient.NewContentDTO() // ContentDTO | Content to be created

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	The key of the owner

Other Parameters

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

Name	Type	Description	Notes

contentDTO | ContentDTO | Content to be created |

Return type

ContentDTO

Authorization

No authorization required

HTTP request headers

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

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

CreateContentBatch

[]ContentDTO CreateContentBatch(ctx, ownerKey).ContentDTO(contentDTO).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | key of the owner whose content has to be created
	contentDTO := []openapiclient.ContentDTO{*openapiclient.NewContentDTO()} // []ContentDTO | List of contents to be created

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OwnerContentAPI.CreateContentBatch(context.Background(), ownerKey).ContentDTO(contentDTO).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OwnerContentAPI.CreateContentBatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateContentBatch`: []ContentDTO
	fmt.Fprintf(os.Stdout, "Response from `OwnerContentAPI.CreateContentBatch`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	key of the owner whose content has to be created

Other Parameters

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

Name	Type	Description	Notes

contentDTO | []ContentDTO | List of contents to be created |

Return type

[]ContentDTO

Authorization

No authorization required

HTTP request headers

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

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

GetContentById

ContentDTO GetContentById(ctx, ownerKey, contentId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | The key of the owner whose content has to be retrieved
	contentId := "contentId_example" // string | The id of the content to be retrieved

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	The key of the owner whose content has to be retrieved
contentId	string	The id of the content to be retrieved

Other Parameters

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

Name	Type	Description	Notes

Return type

ContentDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetContentsByOwner

[]ContentDTO GetContentsByOwner(ctx, ownerKey).Content(content).Label(label).Active(active).Custom(custom).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	content := []string{"Inner_example"} // []string | The ID of a content to fetch. If defined, the list of contents returned by this method will only include those matching the given ID. May be specified multiple times to filter on multiple content IDs.  (optional)
	label := []string{"Inner_example"} // []string | The labels of content to fetch. If defined, the list of content returned by this endpoint will only include those matching the given labels (case-insensitive). May be specified multiple times to filter on multiple labels. If multiple labels are provided, any content matching any of the provided labels will be returned.  (optional)
	active := "{"include":{"value":"include","description":"indicates the query should include matching active content, along with any inactive\ncontent\n"},"exclude":{"value":"exclude","description":"indicates the query should exclude, or omit, active content, returning only matching\ninactive content\n"},"exclusive":{"value":"exclusive","description":"indicates the query should only include matching active content, excluding any inactive\ncontent\n"}}" // string | A value indicating how 'active' content should be considered when fetching content, where 'active' is defined as a content that is currently in use by a subscription with a start time in the past and that has not yet expired, or in use by a product which itself is considered 'active.' Must be one of 'include', 'exclude', or 'exclusive' indicating that active content should be included along with inactive content, excluded (omitted) from the results, or exclusively selected as the only content to return. Defaults to 'exclusive'.  (optional) (default to "exclusive")
	custom := "{"include":{"value":"include","description":"indicates the query should include matching custom content, along with any matching\nglobally defined content\n"},"exclude":{"value":"exclude","description":"indicates the query should exclude, or omit, custom content, returning only matching\nglobally defined content\n"},"exclusive":{"value":"exclusive","description":"indicates the query should only include matching custom content, excluding any globally\ndefined content\n"}}" // string | A value indicating how custom content are considered when fetching content, where 'custom' is defined as content that did not originate from a refresh operation nor manifest import. Must be one of 'include', 'exclude', or 'exclusive' indicating that custom content should be passively included, excluded or omitted from the output, or exclusively selected as the only content to return.  (optional) (default to "include")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OwnerContentAPI.GetContentsByOwner(context.Background(), ownerKey).Content(content).Label(label).Active(active).Custom(custom).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OwnerContentAPI.GetContentsByOwner``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetContentsByOwner`: []ContentDTO
	fmt.Fprintf(os.Stdout, "Response from `OwnerContentAPI.GetContentsByOwner`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key

Other Parameters

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

Name	Type	Description	Notes

content | []string | The ID of a content to fetch. If defined, the list of contents returned by this method will only include those matching the given ID. May be specified multiple times to filter on multiple content IDs. | label | []string | The labels of content to fetch. If defined, the list of content returned by this endpoint will only include those matching the given labels (case-insensitive). May be specified multiple times to filter on multiple labels. If multiple labels are provided, any content matching any of the provided labels will be returned. | active | string | A value indicating how 'active' content should be considered when fetching content, where 'active' is defined as a content that is currently in use by a subscription with a start time in the past and that has not yet expired, or in use by a product which itself is considered 'active.' Must be one of 'include', 'exclude', or 'exclusive' indicating that active content should be included along with inactive content, excluded (omitted) from the results, or exclusively selected as the only content to return. Defaults to 'exclusive'. | [default to "exclusive"] custom | string | A value indicating how custom content are considered when fetching content, where 'custom' is defined as content that did not originate from a refresh operation nor manifest import. Must be one of 'include', 'exclude', or 'exclusive' indicating that custom content should be passively included, excluded or omitted from the output, or exclusively selected as the only content to return. | [default to "include"]

Return type

[]ContentDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RemoveContent

RemoveContent(ctx, ownerKey, contentId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | The key of the owner whose content has to be deleted
	contentId := "contentId_example" // string | The ID of the content to be deleted

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.OwnerContentAPI.RemoveContent(context.Background(), ownerKey, contentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OwnerContentAPI.RemoveContent``: %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.
ownerKey	string	The key of the owner whose content has to be deleted
contentId	string	The ID of the content to be deleted

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

UpdateContent

ContentDTO UpdateContent(ctx, ownerKey, contentId).ContentDTO(contentDTO).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	ownerKey := "ownerKey_example" // string | The key of the owner to be updated
	contentId := "contentId_example" // string | The ID of the Content to be updated
	contentDTO := *openapiclient.NewContentDTO() // ContentDTO | Content to be updated

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	The key of the owner to be updated
contentId	string	The ID of the Content to be updated

Other Parameters

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

Name	Type	Description	Notes

contentDTO | ContentDTO | Content to be updated |

Return type

ContentDTO

Authorization

No authorization required

HTTP request headers

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

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

Files

OwnerContentAPI.md

Latest commit

History

OwnerContentAPI.md

File metadata and controls

\OwnerContentAPI

CreateContent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateContentBatch

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetContentById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetContentsByOwner

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveContent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateContent

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers