Jump to

• Request
• Response

listClientApplicationChangedAssets

get

/ccadmin/v1/clientApplications/{application}/changedAssets

Retrieve any changed assets for OSF Design Studio since a particular time provided.

Request

Supported Media Types

• application/json

Path Parameters

• application: string
  The OSF application being queried.

Query Parameters

• live(optional): boolean
  Set to true to view published/live assets, set to false to view unpublished/preview assets
• since(optional): string
  ISO-8601 timestamp for when to start checking assets since.
• until(optional): string
  ISO-8601 timestamp for when to end checking assets until.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds. This will be split into six parts; Components, Containers, Layouts, Slots, Styles, and Text Snippets.

Body ()

Root Schema : listClientApplicationChangedAssets_response

Type: object

Show Source

• applicationId(optional): string
  Default Value: core-commerce-reference-store

  The application related to this particular asset.
• assetPath(optional): string
  Default Value: /asset/components/example-web-content

  The directory path of a particular asset.
• id(optional): integer
  Default Value: 100099

  The repository id of the asset.
• name(optional): string
  Default Value: example-web-content

  The name of a particular asset.

{
    "type":"object",
    "properties":{
        "assetPath":{
            "default":"/asset/components/example-web-content",
            "description":"The directory path of a particular asset.",
            "type":"string"
        },
        "name":{
            "default":"example-web-content",
            "description":"The name of a particular asset.",
            "type":"string"
        },
        "id":{
            "default":100099,
            "description":"The repository id of the asset.",
            "type":"integer"
        },
        "applicationId":{
            "default":"core-commerce-reference-store",
            "description":"The application related to this particular asset.",
            "type":"string"
        }
    }
}

400 Response

Following model is returned when operation fails. See individual error codes for details; 211000 - Date format cannot be parsed properly. Make sure it's ISO-8601 compatible. 211001 - Since date cannot be after until date or current time. 211002 - Until date cannot be before since date or deployment time.

Body ()

Root Schema : listClientApplicationChangedAssets_badRequest

Type: object

Show Source

• errorCode(optional): string
  Default Value: 211000/211001/211002

  The numerical code identifying the error.
• message(optional): string
  Default Value: 211000 - Malformed Date/ 211001 - Invalid Since Date/ 211002 - Invalid Until Date

  The localized message describing the error
• status(optional): string
  Default Value: 400

  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "default":"211000/211001/211002",
            "description":"The numerical code identifying the error.",
            "type":"string"
        },
        "message":{
            "default":"211000 - Malformed Date/ 211001 - Invalid Since Date/ 211002 - Invalid Until Date",
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "default":400,
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

500 Response

Following model is returned when operation fails - ApplicationId cannot be null.

Body ()

Root Schema : listClientApplicationChangedAssets_InvalidIdresponse

Type: object

Show Source

• errorCode(optional): string
  Default Value: 00000000

  The numerical code identifying the error.
• message(optional): string
  Default Value: Ids cannot be null

  The localized message describing the error
• status(optional): string
  Default Value: 500

  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "default":"00000000",
            "description":"The numerical code identifying the error.",
            "type":"string"
        },
        "message":{
            "default":"Ids cannot be null",
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "default":500,
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

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