Changes for page REST API

Last modified by Anca Luca on 2023/04/19
<
From version < 44.1 >
edited by Guillaume Delhumeau
on 2015/07/09
To version < 46.1 >
edited by Guillaume Delhumeau
on 2015/08/26
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -325,7 +325,7 @@
325 325  ** **Status codes:**
326 326  *** 200: If the request was successful.
327 327  
328 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
328 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/search?q~={keywords}~[~[&scope~={name,content,title,objects}...]&number~=n] ===
329 329  
330 330  * **HTTP Method:** GET
331 331  ** **Media types:**
... ... @@ -337,7 +337,7 @@
337 337  
338 338  == Page resources ==
339 339  
340 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages[?start~=offset&number~=n] ===
340 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages[?start~=offset&number~=n] ===
341 341  
342 342  * **HTTP Method:** GET
343 343  ** **Media types:**
... ... @@ -347,7 +347,7 @@
347 347  *** 200: If the request was successful.
348 348  *** 401: If the user is not authorized.
349 349  
350 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName} ===
350 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName} ===
351 351  
352 352  * **HTTP Method:** GET
353 353  ** **Media types:**
... ... @@ -383,7 +383,7 @@
383 383  *** 204: If the request was successful.
384 384  *** 401: If the user is not authorized.
385 385  
386 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history[?start~=offset&number~=n] ===
386 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history[?start~=offset&number~=n] ===
387 387  
388 388  * **HTTP Method:** GET
389 389  ** **Media types:**
... ... @@ -393,7 +393,7 @@
393 393  *** 200: If the request was successful.
394 394  *** 401: If the user is not authorized.
395 395  
396 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version} ===
396 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version} ===
397 397  
398 398  * **HTTP Method:** GET
399 399  ** **Media types:**
... ... @@ -403,7 +403,7 @@
403 403  *** 200: If the request was successful.
404 404  *** 401: If the user is not authorized.
405 405  
406 -==== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations[?start~=offset&number~=n] ====
406 +==== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations[?start~=offset&number~=n] ====
407 407  
408 408  * **HTTP Method:** GET
409 409  ** **Media types:**
... ... @@ -413,7 +413,7 @@
413 413  *** 200: If the request was successful.
414 414  *** 401: If the user is not authorized.
415 415  
416 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{language} ===
416 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{language} ===
417 417  
418 418  * **HTTP Method:** GET
419 419  ** **Media types:**
... ... @@ -449,7 +449,7 @@
449 449  *** 204: If the request was successful.
450 450  *** 401: If the user is not authorized.
451 451  
452 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{language}/history ===
452 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{language}/history ===
453 453  
454 454  * **HTTP Method:** GET
455 455  ** **Media types:**
... ... @@ -459,7 +459,7 @@
459 459  *** 200: If the request was successful.
460 460  *** 401: If the user is not authorized.
461 461  
462 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/translations/{lang}/history/{version} ===
462 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/translations/{lang}/history/{version} ===
463 463  
464 464  * **HTTP Method:** GET
465 465  ** **Media types:**
... ... @@ -469,7 +469,7 @@
469 469  *** 200: If the request was successful.
470 470  *** 401: If the user is not authorized.
471 471  
472 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/children ===
472 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/children ===
473 473  
474 474  * **HTTP Method:** GET
475 475  ** **Media types:**
... ... @@ -491,7 +491,7 @@
491 491  
492 492  == Tag resources ==
493 493  
494 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/tags ===
494 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/tags ===
495 495  
496 496  * **HTTP Method:** GET
497 497  ** **Media types:**
... ... @@ -537,7 +537,7 @@
537 537  
538 538  == Comments resources ==
539 539  
540 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/comments[?start~=offset&number~=n] ===
540 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments[?start~=offset&number~=n] ===
541 541  
542 542  * **HTTP Method:** GET
543 543  ** **Media types:**
... ... @@ -561,7 +561,7 @@
561 561  *** 201: If the comment was created. (The Location header will contain the URI where the comment has been created.)
562 562  *** 401: If the user is not authorized.
563 563  
564 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/comments/{commentId} ===
564 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/comments/{commentId} ===
565 565  
566 566  * **HTTP Method:** GET
567 567  ** **Media types:**
... ... @@ -571,7 +571,7 @@
571 571  *** 200: If the request was successful.
572 572  *** 401: If the user is not authorized.
573 573  
574 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/comments ===
574 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments ===
575 575  
576 576  * **HTTP Method:** GET
577 577  ** **Media types:**
... ... @@ -581,7 +581,7 @@
581 581  *** 200: If the request was successful.
582 582  *** 401: If the user is not authorized.
583 583  
584 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/comments/{commentId} ===
584 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/comments/{commentId} ===
585 585  
586 586  * **HTTP Method:** GET
587 587  ** **Media types:**
... ... @@ -593,7 +593,7 @@
593 593  
594 594  == Attachments resources ==
595 595  
596 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments[?start~=offset&number~=n] ===
596 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments[?start~=offset&number~=n] ===
597 597  
598 598  * **HTTP Method:** GET
599 599  ** **Media types:**
... ... @@ -603,7 +603,7 @@
603 603  *** 200: If the request was successful.
604 604  *** 401: If the user is not authorized.
605 605  
606 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName} ===
606 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName} ===
607 607  
608 608  * **HTTP Method:** GET
609 609  ** **Media types:**
... ... @@ -635,7 +635,7 @@
635 635  *** 204: If the attachment was deleted.
636 636  *** 401: If the user is not authorized.
637 637  
638 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===
638 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments[?start~=offset&number~=n] ===
639 639  
640 640  * **HTTP Method:** GET
641 641  ** **Media types:**
... ... @@ -645,7 +645,7 @@
645 645  *** 200: If the request was successful.
646 646  *** 401: If the user is not authorized.
647 647  
648 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/attachments/{attachmentName} ===
648 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/attachments/{attachmentName} ===
649 649  
650 650  * **HTTP Method:** GET
651 651  ** **Media types:**
... ... @@ -655,7 +655,7 @@
655 655  *** 200: If the request was successful.
656 656  *** 401: If the user is not authorized.
657 657  
658 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName}/history ===
658 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history ===
659 659  
660 660  * **HTTP Method:** GET
661 661  ** **Media types:**
... ... @@ -665,7 +665,7 @@
665 665  *** 200: If the request was successful.
666 666  *** 401: If the user is not authorized.
667 667  
668 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/attachments/{attachmentName}/history/{version} ===
668 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/attachments/{attachmentName}/history/{version} ===
669 669  
670 670  * **HTTP Method:** GET
671 671  ** **Media types:**
... ... @@ -675,7 +675,7 @@
675 675  *** 200: If the request was successful.
676 676  *** 401: If the user is not authorized.
677 677  
678 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/attachments[?name~=attachmentName&page~=pageName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
678 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/attachments[?name~=attachmentName&page~=pageName&author~=authorName&types~=attachmentTypeList&start~=offset&number~=n] ===
679 679  
680 680  * **HTTP Method:** GET
681 681  ** **Media types:**
... ... @@ -697,7 +697,7 @@
697 697  
698 698  == Object resources ==
699 699  
700 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects[?start~=offset&number~=n] ===
700 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects[?start~=offset&number~=n] ===
701 701  
702 702  * **HTTP Method:** GET
703 703  ** **Media types:**
... ... @@ -720,7 +720,7 @@
720 720  *** 201: If the object was created (The Location header will contain the URI associated to the newly created object).
721 721  *** 401: If the user is not authorized.
722 722  
723 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===
723 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}[?start~=offset&number~=n] ===
724 724  
725 725  * **HTTP Method:** GET
726 726  ** **Media types:**
... ... @@ -730,7 +730,7 @@
730 730  *** 200: If the request was successful.
731 731  *** 401: If the user is not authorized.
732 732  
733 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber} ===
733 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber} ===
734 734  
735 735  * **HTTP Method:** GET
736 736  ** **Media types:**
... ... @@ -762,7 +762,7 @@
762 762  *** 204: If the object was deleted.
763 763  *** 401: If the user is not authorized.
764 764  
765 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber}/properties ===
765 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties ===
766 766  
767 767  * **HTTP Method:** GET
768 768  ** **Media types:**
... ... @@ -772,7 +772,7 @@
772 772  *** 200: If the request was successful.
773 773  *** 401: If the user is not authorized.
774 774  
775 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName} ===
775 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/objects/{className}/{objectNumber}/properties/{propertyName} ===
776 776  
777 777  * **HTTP Method:** GET
778 778  ** **Media types:**
... ... @@ -796,7 +796,7 @@
796 796  *** 202: If the object was updated.
797 797  *** 401: If the user is not authorized.
798 798  
799 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===
799 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects[?start~=offset&number~=n] ===
800 800  
801 801  * **HTTP Method:** GET
802 802  ** **Media types:**
... ... @@ -806,7 +806,7 @@
806 806  *** 200: If the request was successful.
807 807  *** 401: If the user is not authorized.
808 808  
809 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===
809 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber} ===
810 810  
811 811  * **HTTP Method:** GET
812 812  ** **Media types:**
... ... @@ -816,7 +816,7 @@
816 816  *** 200: If the request was successful.
817 817  *** 401: If the user is not authorized.
818 818  
819 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===
819 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties ===
820 820  
821 821  * **HTTP Method:** GET
822 822  ** **Media types:**
... ... @@ -826,7 +826,7 @@
826 826  *** 200: If the request was successful.
827 827  *** 401: If the user is not authorized.
828 828  
829 -=== /wikis/{wikiName}/spaces/{spaceName}(/spaces/{nestedSpaceName})*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===
829 +=== /wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}/history/{version}/objects/{className}/{objectNumber}/properties/{propertyName} ===
830 830  
831 831  * **HTTP Method:** GET
832 832  ** **Media types:**
... ... @@ -888,6 +888,30 @@
888 888  *** 200: If the request was successful.
889 889  *** 401: If the user is not authorized.
890 890  
891 +== Job resources ==
892 +
893 +A job is identified by an ID (##jobId##) which is a list of strings. In the REST URL, you have to represent the ID with a list of strings separated by ##/##. (eg: ##refactoring/delete/11451##).
894 +
895 +=== /jobstatus/{jobId} ===
896 +
897 +* **HTTP Method:** GET
898 +** **Media types:**
899 +*** application/xml (JobStatus element)
900 +** **Description:** status of a job
901 +** **Status codes:**
902 +*** 200: If the request was successful.
903 +*** 404: If the job status has not been found
904 +
905 +=== /joblog/{jobId}[?level~={error,warn,info,debug,trace}&fromLevel~={error,warn,info,debug,trace}] ===
906 +
907 +* **HTTP Method:** GET
908 +** **Media types:**
909 +*** application/xml (JobLog element)
910 +** **Description:** log of a job
911 +** **Status codes:**
912 +*** 200: If the request was successful.
913 +*** 404: If the job status has not been found
914 +
891 891  == Other resources ==
892 892  
893 893  === /wikis/{wikiName}/modifications[?start~=offset&number~=n&date~=t] ===

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected