İçeriğe geç
Store API

Theme

Serverhttps://magaza-adiniz.myideasoft.com

Theme LIST

GET
https://magaza-adiniz.myideasoft.com
/api/themes
Bearer

Theme LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Themes adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

status
​integer · min: 0 · max: 1

Theme status

version
​string · enum

Theme version

Enum values:
2
platform
​string

Platform type

type
​string

Theme type

Theme LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme POST

POST
https://magaza-adiniz.myideasoft.com
/api/themes
Bearer

Theme POST › Request Body

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme GET

GET
https://magaza-adiniz.myideasoft.com
/api/themes/{id}
Bearer

Theme GET › path Parameters

id
​string · pattern: \d+ · required

Theme GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme PUT

PUT
https://magaza-adiniz.myideasoft.com
/api/themes/{id}
Bearer

Theme PUT › path Parameters

id
​string · pattern: \d+ · required

Theme PUT › Request Body

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/themes/{id}
Bearer

Theme DELETE › path Parameters

id
​string · pattern: \d+ · required

Theme DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned

Theme GetAssetAction GET

GET
https://magaza-adiniz.myideasoft.com
/api/themes/{id}/assets
Bearer

Theme GetAssetAction GET › path Parameters

id
​string · required

Theme GetAssetAction GET › query Parameters

key
​string · required

Asset key.

Theme GetAssetAction GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

No data returned

Theme PutAssetAction PUT

PUT
https://magaza-adiniz.myideasoft.com
/api/themes/{id}/assets
Bearer

Theme PutAssetAction PUT › path Parameters

id
​string · required

Theme PutAssetAction PUT › Request Body

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme PutAssetAction PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

platform
​string · enum · required

Temanın kullanılacağı platform türünü belirtir. Seçenekler: | desktop: asaüstü platformu için kullanılacak tema.. | mobile: Mobil platformu için kullanılacak tema..

Enum values:
desktop
mobile
Example: desktop
name
​string · maxLength: 255 · required

Temanın ismi.

Example: Chalcedon
status
​integer · enum · required

Temanın aktiflik durumunu belirtir. (0 = Pasif, 1 = Aktif). Seçenekler: | 0: 0 | 1: 1

Enum values:
0
1
Example: 0
id
​integer

Tema nesnesine ait benzersiz kimlik (ID) değeri.

Example: 123
type
​string · enum

Tema tipini belirtir. Seçenekler: | self: Kişisel olarak oluşturulan özel tema. | standard: Sistem tarafından sağlanan standart tema.

Enum values:
self
standard
Example: standard
preset
​string

Temaya ait varsayılan renk

Example:
directoryName
​string

Temanın bulunduğu dizin adı.

Example: tpl-chalcedon
revision
​integer
version
​integer

Tema versiyon numarasını belirtir. Seçenekler: | 1: 1 | 2: 2

assetJson
​string · writeOnly
renderJson
​string · writeOnly
createdAt
​string · date-time

Tema nesnesinin oluşturulma tarihi.

Example: 2018-02-21T09:36:03+0300
updatedAt
​string · date-time

Tema nesnesinin güncellenme tarihi.

Example: 2018-02-21T15:01:03+0300
attachment
​string · writeOnly

Temaya ait dosya ekini ifade eder.

packageGroup
​integer · enum
Enum values:
1
2
3
4
isCopyright
​integer · enum
Enum values:
0
1

Theme DeleteAssetAction DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/themes/{id}/assets
Bearer

Theme DeleteAssetAction DELETE › path Parameters

id
​string · required

Theme DeleteAssetAction DELETE › query Parameters

key
​string · required

Asset key.

Theme DeleteAssetAction DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned