シーン管理関連インタフェースのドキュメントの説明

2509 ワード

説明
1.          HTTP  

2.          ,     Token,         ,      token      Token。

3.   URL `:`  :         ,             。    URL: /user/idencode/:telphone   `telphone`        ,                     。

4.           :

      
      
         

5.        `?`   :       `?`  ,            。

シーン関連
シーンの追加/更新
  
    /freeserver-ocelot/scene/upsert

    
    POST

    
    application/json

  
    {
        pid?: string,
        name: string,
        detail?: Object,
        share?:boolean
    }

    pid:       pid,         。

    name:     。
    
    detail:      。
    
    share:    ,  false   

    
    
      :
        {"stat":0,"msg":"  ","val":pid}
    
      :
        {"stat": 0  ,"msg":"      "}

個々のシーンの詳細を問い合わせる
  
    /freeserver-ocelot/scene/getone/:pid

    
    GET

   
     

    
      :
        {"stat":0, "msg":"  ", val:{pid, name, userid, createTime}}
    
      :
        {"stat": 0  , "msg":"    "}

すべてのシーンを取得
  
     /freeserver-ocelot/scene/getall

    
    POST

   
    {
        keyword?: string,
        offset?: number,
        pagecount: number,
        share?: boolean
    }

    keyword:            (     name  )

    offset:       。   :(  -1)*    。   0.

    pagecount:     。   20
    
    share:true       ,false        ,        

    
      :
        {"stat":0, "msg":"  ", val:[]}
    
      :
        {"stat": 0  , "msg":"    "}

すべてのシーン数を取得
  
     /freeserver-ocelot/scene/count

    
    POST

   
    {
        keyword?: string
    }

    keyword:       

    
      :
        {"stat":0, "msg":"  ", val:    }
    
      :
        {"stat": 0  , "msg":"    "}

シーンを削除
  
     /freeserver-ocelot/scene/remove/:pid

    
    GET

   
     

    
      :
        {"stat":0, "msg":"  "}
    
      :
        {"stat": 0  , "msg":"    "}

アクセスキー共有urlの取得
  
     /freeserver-ocelot/scene/getcapaurl
    
    POST

   
    {
        pid: string,
        accesskey:string
    }

    
      :
        {"stat":0, "msg":"  ", val:url}
    
      :
        {"stat": 0  , "msg":"    "}