Jump to

• Request
• Response

Translate via exchange

post

/fscmRestApi/resources/11.13.18.05/punchoutConnections/{punchoutConnectionsUniqID}/action/translateViaExchange

Translate the punchout cart from cXML to XML for Oracle Exchange.

Request

Path Parameters

• punchoutConnectionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CatalogId and PunchoutItemId ---for the Punchout Connections resource and used to uniquely identify an instance of Punchout Connections. The client should not generate the hash key value. Instead, the client should query on the Punchout Connections collection resource with a filter on the primary key values in order to navigate to a specific instance of Punchout Connections.
  
  For example: punchoutConnections?q=CatalogId=<value1>;PunchoutItemId=<value2>

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• translate: object translate
  Additional Properties Allowed: additionalProperties

  Punchout payload to be translated.

{
    "type":"object",
    "properties":{
        "translate":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Punchout payload to be translated.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : translate

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Punchout payload to be translated.",
    "nullable":true
}

Punchout payload to be translated.

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, the action will return the translated cart in XML. Otherwise, it will return an error.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, the action will return the translated cart in XML. Otherwise, it will return an error."
        }
    },
    "additionalProperties":false
}

Back to Top