Create or update an array of catalog

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 50
Show Source
Nested Schema : CatalogOracle
Title: CatalogOracle
Match All
Show Source
  • Catalog
    Title: Catalog
    Discriminator: { "propertyName":"@type", "mapping":{ "Catalog":"#/components/schemas/Catalog", "CatalogOracle":"#/components/schemas/CatalogOracle" } }
  • type
Nested Schema : Catalog
Type: object
Title: Catalog
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Back to Top

Response

Supported Media Types

200 Response

Your request is successful and the resources have been created or updated.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : CatalogOracle
Title: CatalogOracle
Match All
Show Source
  • Catalog
    Title: Catalog
    Discriminator: { "propertyName":"@type", "mapping":{ "Catalog":"#/components/schemas/Catalog", "CatalogOracle":"#/components/schemas/CatalogOracle" } }
  • type
Nested Schema : Catalog
Type: object
Title: Catalog
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to create or update an array of catalog by submitting a put request on the REST resource using cURL.

cURL Command

curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs -H 'Content-Type: application/json' -D @put_catalogs.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

[
    {
        "id": "CommunicationCatalog001",
        "name": "CommunicationCatalog 001",
        "description": "CommunicationCatalog Description",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/CommunicationCatalog",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2021-07-03T09:43:37.000Z",
        "createdBy": "booth",
        "lastUpdate": "2021-07-03T09:43:37.231Z",
        "lastUpdatedBy": "booth",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "validFor": {
            "startDateTime": "2020-08-02T10:00:38.028Z",
            "endDateTime": "2021-08-03T10:00:38.029Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/IntegrationProject"
        },
        "category": [
            {
                "id": "SwissCommCategory001",
                "name": "SwissCommCategory 001",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory",
                "version": "1.0",
                "@referredType": "CategoryOracle"
            }
        ]
    },
    {
        "id": "CommunicationCatalog002",
        "name": "CommunicationCatalog 002",
        "description": "CommunicationCatalog Description",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/catalog/CommunicationCatalog",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "created": "2021-07-03T09:43:37.000Z",
        "createdBy": "booth",
        "lastUpdate": "2021-07-03T09:43:37.231Z",
        "lastUpdatedBy": "booth",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "validFor": {
            "startDateTime": "2020-08-02T10:00:38.028Z",
            "endDateTime": "2021-08-03T10:00:38.029Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/IntegrationProject"
        },
        "category": [
            {
                "id": "SwissCommCategory002",
                "name": "SwissCommCategory 002",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory",
                "version": "1.0",
                "@referredType": "CategoryOracle"
            }
        ]
    }
]

Example of Response Body

The following shows an example of the response body in JSON format.

[
    {
        "id": "CommunicationCatalog001",
        "name": "CommunicationCatalog 001",
        "description": "CommunicationCatalog Description",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs/CommunicationCatalog001",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "validFor": {
            "startDateTime": "2020-08-02T10:00:38.028Z",
            "endDateTime": "2021-08-03T10:00:38.029Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "category": [
            {
                "id": "SwissCommCategory001",
                "name": "SwissCommCategory001",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory001",
                "version": "1.0",
                "@referredType": "CategoryOracle"
            }
        ]
    },
    {
        "id": "CommunicationCatalog002",
        "name": "CommunicationCatalog 002",
        "description": "CommunicationCatalog Description",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/catalogs/CommunicationCatalog002",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "@type": "CatalogOracle",
        "@baseType": "Catalog",
        "validFor": {
            "startDateTime": "2020-08-02T10:00:38.028Z",
            "endDateTime": "2021-08-03T10:00:38.029Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "category": [
            {
                "id": "SwissCommCategory002",
                "name": "SwissCommCategory002",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/category/SwissCommCategory002",
                "version": "1.0",
                "@referredType": "CategoryOracle"
            }
        ]
    }
]
Back to Top