New-ITGlueDocumentImage
SYNOPSIS
Creates a new document image
SYNTAX
New-ITGlueDocumentImage -Data <Object> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The New-ITGlueDocumentImage cmdlet creates a new document image
Images are placed using the ‘target’ attribute which specifies whether the image is for a gallery or inline in a document
The image must be uploaded as Base64-encoded content with a file name.
Required attributes: target: { type: ‘gallery’|’document’, id: integer } image.content: Base64-encoded image data image.file-name: Original filename with extension
EXAMPLES
EXAMPLE 1
New-ITGlueDocumentImage -Data $JsonBody
Creates a new image with the structured JSON object
PARAMETERS
-Data
JSON body depending on bulk changes or not
Do NOT include the “Data” property in the JSON object as this is handled by the Invoke-ITGlueRequest function
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
N/A
RELATED LINKS
https://celerium.github.io/Celerium.ITGlue/site/DocumentImages/New-ITGlueDocumentImage.html