Skip to content

CbacBanner.md

Latest commit

 

History

History
61 lines (42 loc) · 2.28 KB

CbacBanner.md

File metadata and controls

61 lines (42 loc) · 2.28 KB

CbacBanner

Method HTTP request Release Stage
get GET /v2/admin/cbacBanner Public Beta

get

Returns a classification banner string and colors for the given set of marking IDs.

Parameters

Name Type Description Notes
display_type Optional[ClassificationBannerDisplayType] The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs [optional]
marking_ids Optional[List[MarkingId]] The marking IDs for which to generate a banner. [optional]
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

CbacBanner

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING. BANNER_LINE is the long classification string used in the header of a document; PORTION_MARKING is a short classification string used for individual paragraphs
display_type = None
# Optional[List[MarkingId]] | The marking IDs for which to generate a banner.
marking_ids = ["MTS", "MNF"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.admin.CbacBanner.get(
        display_type=display_type, marking_ids=marking_ids, preview=preview
    )
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling CbacBanner.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 CbacBanner application/json

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