Jump to

• Request
• Response

listProfileRequests

get

/ccadmin/v1/profileRequests

List Profile Requests. This operation is used to get the collection of profile requests from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of profile request.

Request

Supported Media Types

• application/json

Query Parameters

• limit(optional): string
  This is the field to determine number of records to be fetched per REST call.
• offset(optional): string
  This field determines the offset/starting index from which data to be fetched.
• q(optional): string
  Query string built as per the SCIM standards that helps to search entered string across profile request properties like 'requestedOrganizationName'.
• sort(optional): string
  This field determines the sort order of the list to be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listProfileRequests_response

Type: object

Show Source

• items(optional): array items
  list of profile request
• limit(optional): integer
  Number of records to be fetched.
• offset(optional): integer
  The offset provided.
• total(optional): integer
  Total number of records present in database matching the searched string.
• totalResults(optional): integer
  Total number of records present in database matching the searched string.

{
    "properties":{
        "total":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset provided.",
            "type":"integer"
        },
        "limit":{
            "description":"Number of records to be fetched.",
            "type":"integer"
        },
        "items":{
            "description":"list of profile request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "site":{
                        "description":"Site",
                        "type":"object",
                        "properties":{
                            "productionURL":{
                                "description":"Production URL of site",
                                "type":"string"
                            },
                            "siteName":{
                                "description":"Name of ite",
                                "type":"string"
                            },
                            "id":{
                                "description":"Repository Id of site",
                                "type":"string"
                            }
                        }
                    },
                    "requestedOrganizationName":{
                        "description":"Requested Organization name given by requester",
                        "type":"string"
                    },
                    "organization":{
                        "description":"Organization",
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"Repository Id of organization",
                                "type":"string"
                            }
                        }
                    },
                    "profile":{
                        "description":"Profile Object",
                        "type":"object",
                        "properties":{
                            "firstName":{
                                "description":"First Name of profile",
                                "type":"string"
                            },
                            "lastName":{
                                "description":"Last Name of profile",
                                "type":"string"
                            },
                            "customerContactId":{
                                "description":"The external customer contact id.",
                                "type":"string"
                            },
                            "id":{
                                "description":"Repository Id of profile",
                                "type":"string"
                            },
                            "email":{
                                "description":"Email of profile",
                                "type":"string"
                            }
                        }
                    },
                    "requestedOrganizationID":{
                        "description":"Requested Organization ID given by requester",
                        "type":"string"
                    },
                    "id":{
                        "description":"Id of the Profile request",
                        "type":"string"
                    },
                    "status":{
                        "description":"Status of the request.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of profile request

Show Source

• Array of: object items

{
    "description":"list of profile request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "site":{
                "description":"Site",
                "type":"object",
                "properties":{
                    "productionURL":{
                        "description":"Production URL of site",
                        "type":"string"
                    },
                    "siteName":{
                        "description":"Name of ite",
                        "type":"string"
                    },
                    "id":{
                        "description":"Repository Id of site",
                        "type":"string"
                    }
                }
            },
            "requestedOrganizationName":{
                "description":"Requested Organization name given by requester",
                "type":"string"
            },
            "organization":{
                "description":"Organization",
                "type":"object",
                "properties":{
                    "id":{
                        "description":"Repository Id of organization",
                        "type":"string"
                    }
                }
            },
            "profile":{
                "description":"Profile Object",
                "type":"object",
                "properties":{
                    "firstName":{
                        "description":"First Name of profile",
                        "type":"string"
                    },
                    "lastName":{
                        "description":"Last Name of profile",
                        "type":"string"
                    },
                    "customerContactId":{
                        "description":"The external customer contact id.",
                        "type":"string"
                    },
                    "id":{
                        "description":"Repository Id of profile",
                        "type":"string"
                    },
                    "email":{
                        "description":"Email of profile",
                        "type":"string"
                    }
                }
            },
            "requestedOrganizationID":{
                "description":"Requested Organization ID given by requester",
                "type":"string"
            },
            "id":{
                "description":"Id of the Profile request",
                "type":"string"
            },
            "status":{
                "description":"Status of the request.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  Id of the Profile request
• organization(optional): object organization
  Organization
• profile(optional): object profile
  Profile Object
• requestedOrganizationID(optional): string
  Requested Organization ID given by requester
• requestedOrganizationName(optional): string
  Requested Organization name given by requester
• site(optional): object site
  Site
• status(optional): string
  Status of the request.

{
    "type":"object",
    "properties":{
        "site":{
            "description":"Site",
            "type":"object",
            "properties":{
                "productionURL":{
                    "description":"Production URL of site",
                    "type":"string"
                },
                "siteName":{
                    "description":"Name of ite",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of site",
                    "type":"string"
                }
            }
        },
        "requestedOrganizationName":{
            "description":"Requested Organization name given by requester",
            "type":"string"
        },
        "organization":{
            "description":"Organization",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Repository Id of organization",
                    "type":"string"
                }
            }
        },
        "profile":{
            "description":"Profile Object",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"First Name of profile",
                    "type":"string"
                },
                "lastName":{
                    "description":"Last Name of profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of profile",
                    "type":"string"
                },
                "email":{
                    "description":"Email of profile",
                    "type":"string"
                }
            }
        },
        "requestedOrganizationID":{
            "description":"Requested Organization ID given by requester",
            "type":"string"
        },
        "id":{
            "description":"Id of the Profile request",
            "type":"string"
        },
        "status":{
            "description":"Status of the request.",
            "type":"string"
        }
    }
}

Nested Schema : organization

Type: object

Organization

Show Source

• id(optional): string
  Repository Id of organization

{
    "description":"Organization",
    "type":"object",
    "properties":{
        "id":{
            "description":"Repository Id of organization",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile Object

Show Source

• customerContactId(optional): string
  The external customer contact id.
• email(optional): string
  Email of profile
• firstName(optional): string
  First Name of profile
• id(optional): string
  Repository Id of profile
• lastName(optional): string
  Last Name of profile

{
    "description":"Profile Object",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First Name of profile",
            "type":"string"
        },
        "lastName":{
            "description":"Last Name of profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of profile",
            "type":"string"
        },
        "email":{
            "description":"Email of profile",
            "type":"string"
        }
    }
}

Nested Schema : site

Type: object

Site

Show Source

• id(optional): string
  Repository Id of site
• productionURL(optional): string
  Production URL of site
• siteName(optional): string
  Name of ite

{
    "description":"Site",
    "type":"object",
    "properties":{
        "productionURL":{
            "description":"Production URL of site",
            "type":"string"
        },
        "siteName":{
            "description":"Name of ite",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of site",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://example.com:9080/ccadmin/v1/profileRequests"
        }
    ],
    "items":[
        {
            "site":{
                "productionURL":null,
                "siteName":"Commerce Site",
                "id":"siteUS"
            },
            "requestedOrganizationName":"Oracle",
            "organization":{
                "id":"100001"
            },
            "profile":{
                "firstName":"User",
                "lastName":"Test",
                "customerContactId":"CRMID_1",
                "id":"100001",
                "email":"[e-mail]"
            },
            "requestedOrganizationID":null,
            "id":100001,
            "status":"approved"
        }
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJvcmdhbml6YXRpb25SZXF1ZXN0cyIsImhhc2giOiJ4S1JsMHc9PSJ9"
}

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| |------------------|------------------| |85000|Invalid Query Expression.| |50012|Invalid Sort options.| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset'.| |100019|If there was any internal error while getting profile requests list.|

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