Skip to content
Ideasoft
Admin API

Form

Serverhttps://your-store.myideasoft.com

Form LIST

GET
https://your-store.myideasoft.com
/admin-api/forms
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki form kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), ID bazlı filtreleme (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Form LIST › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Form sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Form kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Form kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

q
​string

Detaylı arama filtresi. q parametresi, alan bazlı arama yapmanıza olanak tanır. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Survey veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Örnek: s=registration

language
​string

Translation Language Code

Form LIST › Responses

The request (GET or PUT) completed successfully.

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form POST

POST
https://your-store.myideasoft.com
/admin-api/forms
Bearer
or
OAuth 2.0

Form POST › Request Body

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form POST › Responses

The create request (POST) completed successfully.

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form COUNT

GET
https://your-store.myideasoft.com
/admin-api/forms/count
Bearer
or
OAuth 2.0

Bu endpoint, sistemdeki form kayıtlarını listelemek veya belirli kriterlere göre filtrelemek için kullanılır. Listeleme işlemi, sayfalama (limit, page), sıralama (sort), ID bazlı filtreleme (id, ids, sinceId) ve arama (q, s) parametreleriyle özelleştirilebilir.

Form COUNT › query Parameters

sort
​string

Sıralama parametresi. - Artan sıralama için: sort=id - Azalan sıralama için: sort=-id Birden fazla alanla sıralama yapmak için virgülle ayırabilirsiniz. Örnek: sort=-createdAt,name

limit
​integer · min: 1 · max: 100

Sayfa başına döndürülecek maksimum Form sayısı. Varsayılan: 20 Örnek: limit=50

Default: 20
page
​integer · min: 1

Listelenecek sayfa numarası. Varsayılan: 1 Örnek: page=2

Default: 1
id
​integer · min: 1

Tek bir Form kaydını döndürmek için kullanılabilir. Örnek: id=42

ids
​string

Birden fazla Form kaydını aynı anda listelemek için virgülle ayrılmış ID değerleri. Örnek: ids=1,2,3,4

sinceId
​integer · min: 1

Belirtilen ID değerinden sonraki kayıtları getirir. Örnek: sinceId=100

q
​string

Detaylı arama filtresi. q parametresi, alan bazlı arama yapmanıza olanak tanır. Kullanım: q[alanAdı]=arananDeğer Örnek: q[name]=Survey veya q[status]=active

s
​string

Genel arama anahtar kelimesiyle filtreleme yapar. Örnek: s=registration

language
​string

Translation Language Code

Form COUNT › Responses

The request (GET or PUT) completed successfully.

Record count response.
total_count
​integer · required

Total number of records matching the filters.


Form GET

GET
https://your-store.myideasoft.com
/admin-api/forms/{id}
Bearer
or
OAuth 2.0

Form GET › path Parameters

id
​string · pattern: \d+ · required

Form GET › Responses

The request (GET or PUT) completed successfully.

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form PUT

PUT
https://your-store.myideasoft.com
/admin-api/forms/{id}
Bearer
or
OAuth 2.0

Form PUT › path Parameters

id
​string · pattern: \d+ · required

Form PUT › Request Body

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form PUT › Responses

The request (GET or PUT) completed successfully.

Form tanımı ve yapılandırma objesi
name
​string · maxLength: 255 · required

Form adı/başlığı

Example: İletişim Formu
​FormFieldSummary[] · required

Form alanları listesi

status
​integer · enum · required

Form aktiflik durumu

Enum values:
0
1
Example: 1
blockStatus
​integer · enum · required

Blok olarak görüntüleme durumu

Enum values:
0
1
Example: 1
language
​string · required
id
​integer

Form için benzersiz kimlik

Example: 101
formKey
​string · maxLength: 255
info
​string
updatedAt
​string · date-time
createdAt
​string · date-time

Form DELETE

DELETE
https://your-store.myideasoft.com
/admin-api/forms/{id}
Bearer
or
OAuth 2.0

Form DELETE › path Parameters

id
​string · pattern: \d+ · required

Form DELETE › Responses

The delete request completed successfully (the response has no content).

No data returned