Jump to

• Request
• Response

getShareSetting

get

/ccstore/v1/shareSettings/{id}

Get Share Setting. This operation is used to get the share setting information from Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the requested Share Setting.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getShareSetting_response

Type: object

Show Source

• account(optional): object account
  Account for in which the sharing should be valid.
• defaultEditEnabled(optional): boolean
  Default edit access of the recipients.
• id(optional): string
  Id of the share setting.
• organizationSharingEnabled(optional): boolean
  Whether resource is shared with all members of the account (if mentioned).
• owner(optional): object owner
  The user who created this share setting.
• relativeTo(optional): string
  ID of the resource being shared.
• sharedEmailConfigs(optional): array sharedEmailConfigs
  Email configurations of the recipients with whom sharing is done using individual email addresses.
• sharedResourceType(optional): string
  Allowed Values: [ "purchaseList" ]

  Type of the resource being shared.

{
    "properties":{
        "owner":{
            "description":"The user who created this share setting.",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"The first name of the user",
                    "type":"string"
                },
                "lastName":{
                    "description":"The last name of the user",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the user",
                    "type":"string"
                },
                "email":{
                    "description":"The email id of the user",
                    "type":"string"
                }
            }
        },
        "organizationSharingEnabled":{
            "description":"Whether resource is shared with all members of the account (if mentioned).",
            "type":"boolean"
        },
        "relativeTo":{
            "description":"ID of the resource being shared.",
            "type":"string"
        },
        "sharedEmailConfigs":{
            "description":"Email configurations of the recipients with whom sharing is done using individual email addresses.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"Id of email config item.",
                        "type":"string"
                    },
                    "editEnabled":{
                        "description":"Whether edit access is provided for the email or not.",
                        "type":"boolean"
                    },
                    "email":{
                        "description":"Email address of the recipient.",
                        "type":"string"
                    }
                }
            }
        },
        "sharedResourceType":{
            "description":"Type of the resource being shared.",
            "type":"string",
            "enum":[
                "purchaseList"
            ]
        },
        "id":{
            "description":"Id of the share setting.",
            "type":"string"
        },
        "defaultEditEnabled":{
            "description":"Default edit access of the recipients.",
            "type":"boolean"
        },
        "account":{
            "description":"Account for in which the sharing should be valid.",
            "type":"object",
            "properties":{
                "name":{
                    "description":"Name of the account",
                    "type":"string"
                },
                "id":{
                    "description":"Id of the account",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : account

Type: object

Account for in which the sharing should be valid.

Show Source

• id(optional): string
  Id of the account
• name(optional): string
  Name of the account

{
    "description":"Account for in which the sharing should be valid.",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the account",
            "type":"string"
        },
        "id":{
            "description":"Id of the account",
            "type":"string"
        }
    }
}

Nested Schema : owner

Type: object

The user who created this share setting.

Show Source

• email(optional): string
  The email id of the user
• firstName(optional): string
  The first name of the user
• id(optional): string
  Repository Id of the user
• lastName(optional): string
  The last name of the user

{
    "description":"The user who created this share setting.",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"The first name of the user",
            "type":"string"
        },
        "lastName":{
            "description":"The last name of the user",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the user",
            "type":"string"
        },
        "email":{
            "description":"The email id of the user",
            "type":"string"
        }
    }
}

Nested Schema : sharedEmailConfigs

Type: array

Email configurations of the recipients with whom sharing is done using individual email addresses.

Show Source

• Array of: object items

{
    "description":"Email configurations of the recipients with whom sharing is done using individual email addresses.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"Id of email config item.",
                "type":"string"
            },
            "editEnabled":{
                "description":"Whether edit access is provided for the email or not.",
                "type":"boolean"
            },
            "email":{
                "description":"Email address of the recipient.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• editEnabled(optional): boolean
  Whether edit access is provided for the email or not.
• email(optional): string
  Email address of the recipient.
• id(optional): string
  Id of email config item.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"Id of email config item.",
            "type":"string"
        },
        "editEnabled":{
            "description":"Whether edit access is provided for the email or not.",
            "type":"boolean"
        },
        "email":{
            "description":"Email address of the recipient.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "owner":{
        "firstName":"Leota",
        "lastName":"Dilliard",
        "id":"bb-100006",
        "email":"[e-mail]"
    },
    "organizationSharingEnabled":true,
    "relativeTo":"gl100001",
    "sharedEmailConfigs":[
    ],
    "sharedResourceType":"purchaseList",
    "id":"100001",
    "defaultEditEnabled":true,
    "account":{
        "name":"National Discount Auto Parts",
        "id":"or-100001"
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |00001000|The user is not authenticated.| |64505|Share setting does not exist or you do not have access to it.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top