API docs by Redocly

share API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the share stack.

ShareService

ShareService_ListAllowedAccountIds

Request Body schema: application/json
required
entityIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "entityIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": [
    ]
}

ShareService_ListByAccountIds

path Parameters
sourceAccountId
required
string <int64>
targetAccountIds
required
Array of strings <int64> non-empty [ items <int64 > ]
query Parameters
resourceIdPrefix
string

If left empty all resourceIds should be returned

Responses

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_ListByResource

Request Body schema: application/json
required
resourceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "resourceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_ListBySubResourceIds

Request Body schema: application/json
required
subResourceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "subResourceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_ListByTargetAccountId

path Parameters
targetAccountId
required
string <int64>
query Parameters
resourceIdPrefix
string

Optional. If left empty all resourceIds should be returned

Responses

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_ListIdsByTargetAccountId

path Parameters
targetAccountId
required
string <int64>
query Parameters
resourceIdPrefix
string
scopes
Array of strings
Items Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"

Optional. If empty array then filter is not applied

Responses

Response samples

Content type
application/json
{
  • "ids": [
    ]
}

ShareService_ListOwners

path Parameters
targetAccountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "sourceAccountIds": [
    ]
}

ShareService_ListPartners

path Parameters
sourceAccountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "targetAccountIds": [
    ]
}

ShareService_ListPartnersOfAsset

path Parameters
assetAccountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "partnerAccountIds": [
    ]
}

ShareService_ListSubResourcesByResourceIds

Request Body schema: application/json
required
resourceIds
required
Array of strings
subResourceIdPrefixes
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "resourceIds": [
    ],
  • "subResourceIdPrefixes": [
    ]
}

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_ListSubResourcesByTargetAccountId

path Parameters
targetAccountId
required
string <int64>
query Parameters
scope
string
Default: "UNDEFINED_SCOPE"
Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"
subResourceIdPrefix
string

Responses

Response samples

Content type
application/json
{
  • "subResourceIds": [
    ]
}

ShareService_Set

Request Body schema: application/json
required
resourceIds
required
Array of strings
scope
required
string (shareShareScope)
Default: "UNDEFINED_SCOPE"
Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"
sourceAccountId
required
string <int64>
targetAccountId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "resourceIds": [
    ],
  • "scope": "UNDEFINED_SCOPE",
  • "sourceAccountId": "string",
  • "targetAccountId": "string"
}

Response samples

Content type
application/json
{
  • "share": {
    }
}

ShareService_SetShareForOwner

Request Body schema: application/json
required
ownerAccountId
required
string <int64>
scopes
required
Array of strings (shareShareScope)
Items Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"
targetAccountId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "ownerAccountId": "string",
  • "scopes": [
    ],
  • "targetAccountId": "string"
}

Response samples

Content type
application/json
{
  • "shares": [
    ]
}

ShareService_Unset

Request Body schema: application/json
required
resourceIds
required
Array of strings
scopes
required
Array of strings (shareShareScope)
Items Enum: "UNDEFINED_SCOPE" "MARKETING_SCOPE" "MANAGEMENT_SCOPE" "ACCOUNTING_SCOPE" "ASSET_SCOPE"
sourceAccountId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "resourceIds": [
    ],
  • "scopes": [
    ],
  • "sourceAccountId": "string"
}

Response samples

Content type
application/json
{ }