Jump to

• Request
• Response

Download punchout catalogs

post

/fscmRestApi/resources/11.13.18.05/punchoutCatalogs/action/downloadPunchoutsFromOBN

Downloads the punchout catalog definitions of the selected suppliers listed on the site of the selected catalog of type Oracle Business Network to create new punchout catalogs.

Request

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

• parentCatalogId: number
  Unique identifier of the parent catalog.
• punchoutCatalogsPayload: string
  Payload for the punchout catalogs to be created.

{
    "type":"object",
    "properties":{
        "punchoutCatalogsPayload":{
            "type":"string",
            "description":"Payload for the punchout catalogs to be created.",
            "nullable":true
        },
        "parentCatalogId":{
            "type":"number",
            "description":"Unique identifier of the parent catalog.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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): object result
  Additional Properties Allowed: additionalProperties

  If the action is successful, it returns the information about new catalogs that were added or skipped because they already existed. Otherwise, it returns the relevant errors.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"If the action is successful, it returns the information about new catalogs that were added or skipped because they already existed. Otherwise, it returns the relevant errors."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"If the action is successful, it returns the information about new catalogs that were added or skipped because they already existed. Otherwise, it returns the relevant errors."
}

If the action is successful, it returns the information about new catalogs that were added or skipped because they already existed. Otherwise, it returns the relevant errors.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top