Jump to

• Request
• Response

create commerce application in IDCS.

post

/ccadmin/v1/idcs/applications

This endpoint creates a commerce application in IDCS. If the application already exists, it returns application info.

Request

Supported Media Types

• application/json

Header Parameters

• X-IDCS-Token(required): string
  The IDCS access token.

Body ()

Root Schema : createApplication_request

Type: object

Show Source

• IDCSUrl(required): string
  The base url of IDCS.
• resourceAppName: string
  Name of the resource app in IDCS.
• resourceName(required): string
  The name of the resource app.
• scope: string
  The scope of the resource app in IDCS.
• userName(required): string
  The username which is used to connect to resource app.

{
    "properties":{
        "IDCSUrl":{
            "description":"The base url of IDCS.",
            "type":"string"
        },
        "scope":{
            "description":"The scope of the resource app in IDCS.",
            "type":"string"
        },
        "resourceName":{
            "description":"The name of the resource app. ",
            "type":"string"
        },
        "userName":{
            "description":"The username which is used to connect to resource app.",
            "type":"string"
        },
        "resourceAppName":{
            "description":"Name of the resource app in IDCS.",
            "type":"string"
        }
    },
    "required":[
        "resourceName",
        "IDCSUrl",
        "userName"
    ],
    "example":{
        "IDCSUrl":"https://example.com",
        "scope":"urn:opc:resource:consumer::all",
        "resourceName":"fusion",
        "userName":"resourceUser",
        "resourceAppName":"Oracle Applications Cloud (Fusion)"
    }
}

Example:

{
    "IDCSUrl":"https://example.com",
    "scope":"urn:opc:resource:consumer::all",
    "resourceName":"fusion",
    "userName":"resourceUser",
    "resourceAppName":"Oracle Applications Cloud (Fusion)"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createApplication_response

Type: object

Show Source

• appId: string
  commerce application Id in IDCS.
• name: string
  Name of the commere application in IDCS.

{
    "properties":{
        "appId":{
            "description":"commerce application Id in IDCS.",
            "type":"string"
        },
        "name":{
            "description":"Name of the commere application in IDCS.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "appId":"d669bddff0f94398be2cdb035fecaa4f",
    "name":"CX Commerce"
}

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| |------------------|------------------| |12106|The required header is missing: {0}| |12111|The property resourceName cannot be blank.| |12111|ResourceName is invalid. Please provide a valid resourceName.| |12108|The property IDCSUrl cannot be blank.| |12109|The property userName cannot be blank.| |12107|Encountered internal error while creating an application.| |12112|Can't retrieve the {0} resource application information from IDCS.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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