URI HTTP methods Schemas Properties See also

Sharing policy

Represents the sharing policy for a portal product.

URI

/v2/portalproducts/portalProductId/sharingpolicy

HTTP methods

GET

Operation ID: GetPortalProductSharingPolicy

Gets the sharing policy for a portal product.

Path parameters
Name	Type	Required	Description
`portalProductId`	String	True	The portal product identifier.

Responses
Status code	Response model	Description
`200`	`GetPortalProductSharingPolicyResponseContent`	Success
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`404`	`NotFoundExceptionResponseContent`	The resource specified in the request was not found.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

PUT

Operation ID: PutPortalProductSharingPolicy

Updates the sharing policy for a portal product.

Path parameters
Name	Type	Required	Description
`portalProductId`	String	True	The portal product identifier.

Responses
Status code	Response model	Description
`200`	None	200 response
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`404`	`NotFoundExceptionResponseContent`	The resource specified in the request was not found.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeletePortalProductSharingPolicy

Deletes the sharing policy for a portal product.

Path parameters
Name	Type	Required	Description
`portalProductId`	String	True	The portal product identifier.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`400`	`BadRequestExceptionResponseContent`	One of the parameters in the request is invalid.
`403`	`AccessDeniedExceptionResponseContent`	403 response
`404`	`NotFoundExceptionResponseContent`	The resource specified in the request was not found.
`429`	`LimitExceededExceptionResponseContent`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "policyDocument": "string"
}

Response bodies


{
  "policyDocument": "string",
  "portalProductId": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "resourceType": "string"
}


{
  "message": "string",
  "limitType": "string"
}

Properties

AccessDeniedExceptionResponseContent

The error message.

Property	Type	Required	Description
`message`	string	False	The message.

BadRequestExceptionResponseContent

The response content for bad request exception.

Property	Type	Required	Description
`message`	string	False	The message of the bad request exception response content.

GetPortalProductSharingPolicyResponseContent

Gets a product sharing policy.

Property Type Required Description

Property	Type	Required	Description
`policyDocument`	string MinLength: 1 MaxLength: 307200	True	The product sharing policy.
`portalProductId`	string Pattern: `^[a-z0-9]+$` MinLength: 10 MaxLength: 30	True	The portal product identifier.

policyDocument

string

MinLength: 1

MaxLength: 307200

True

The product sharing policy.

portalProductId

string

Pattern: ^[a-z0-9]+$

MinLength: 10

MaxLength: 30

True

The portal product identifier.

LimitExceededExceptionResponseContent

The response content for limit exceeded exception.

Property	Type	Required	Description
`limitType`	string	False	The limit type of the limit exceeded exception response content.
`message`	string	False	The message of the limit exceeded exception response content.

NotFoundExceptionResponseContent

The response content for not found exception.

Property	Type	Required	Description
`message`	string	False	The message of the not found exception response content.
`resourceType`	string	False	The resource type of the not found exception response content.

PutPortalProductSharingPolicyRequestContent

The request content.

Property Type Required Description

Property	Type	Required	Description
`policyDocument`	string MinLength: 1 MaxLength: 307200	True	The product sharing policy.

policyDocument

string

MinLength: 1

MaxLength: 307200

True

The product sharing policy.