Jump to

• Request
• Response

Retrieves the general information of a registered public user's account profiles.

post

/fscmRestApi/resources/11.13.18.05/publicSectorUserProfiles

Retrieves the general information for a registered public user's account profiles such as the profile's basic information and profile name. In addition, calculates the statistic results related to the profile, such as how many contacts belong to the profile.

Request

Supported Media Types

• application/vnd.oracle.adf.action+json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorUserProfiles-getGeneralInfoByUserIdRequest

Type: object

Show Source

• name(optional): string
  Allowed Values: [ "getGeneralInfoByUserId" ]

  This parameter value must be set to "getGeneralInfoByUserId".
• parameters(optional): array parameters
  Minimum Number of Items: 1

  Maximum Number of Items: 1

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "getGeneralInfoByUserId"
            ],
            "description":"This parameter value must be set to \"getGeneralInfoByUserId\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "userId":{
                            "format":"int64",
                            "type":"integer",
                            "description":"The unique identifier for a user in the fusion system."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":1,
            "maxItems":1,
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Show Source

• Array of: object parameters-items[0]

{
    "items":[
        {
            "properties":{
                "userId":{
                    "format":"int64",
                    "type":"integer",
                    "description":"The unique identifier for a user in the fusion system."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":1,
    "maxItems":1,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• userId(optional): integer(int64)
  The unique identifier for a user in the fusion system.

{
    "properties":{
        "userId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a user in the fusion system."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.actionresult+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorUserProfiles-getGeneralInfoByUserIdResponse

Type: object

Show Source

• return(optional): string
  Returns a JSON string object, which contains an array of a profile's general information.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"Returns a JSON string object, which contains an array of a profile's general information."
        }
    },
    "type":"object"
}

Back to Top