Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

Get All Journal Steps

GET /ssp/api/1/reference/journalStep

Security

SERVICE_REFERENCE_READ

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED<br>
start : First result (0-based index) to return<br>
limit : Maximum number of results to return<br>
sort : Property name<br>
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "CAPSession",
      "description" : "CAP Session.",
      "sortOrder" : 1},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "Transition",
      "description" : "Transition."
      "sortOrder" : 1},
     ...
    ]
}


Get All Journal Steps for Track

GET /ssp/api/1/reference/journalTrack/{id}/journalSteps

Security

SERVICE_REFERENCE_READ

Parameters

status : ALL, ACTIVE, INACTIVE, DELETED
start : First result (0-based index) to return
limit : Maximum number of results to return
sort : Property name
sortDirection : Ascending/descending keyword (ASC/DESC or ASCENDING/DESCENDING)

Returns

{"success" : "true",
 "results" : "100",
 "rows" : 
    [{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "CAPSession",
      "description" : "CAP Session.",
      "sortOrder" : 1},
     {"id" : "7ed6d720-7f91-11e1-b0c4-0800200c9a66",
      "createdDate" : "1332216000000",
      "createdBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "modifiedDate" : "1332216000000",
      "modifiedBy" : 
         {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
          "firstName" : "John",
          "lastName" : "Doe"},  
      "objectStatus" : "ACTIVE",
      "name" : "Transition",
      "description" : "Transition."
      "sortOrder" : 1},
     ...
    ]
}


Get One Journal Step

GET /ssp/api/1/reference/journalStep/{id}

Security

SERVICE_REFERENCE_READ

Returns

JournalStep

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "CAPSession",
 "description" : "CAP Session.",
 "sortOrder" : 1}

 

Create a Journal Step

POST /ssp/api/1/reference/journalStep

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"name" : "CAPSession",
 "description" : "CAP Session.",
 "sortOrder" : 1}

Returns

JournalStep

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "CAPSession",
 "description" : "CAP Session.",
 "sortOrder" : 1}

 

Save a Journal Step

PUT /ssp/api/1/reference/journalStep/{id}

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "CAPSession",
 "description" : "CAP Session.",
 "sortOrder" : 1}

Returns

JournalStep

{"id" : "23befc50-7f91-11e1-b0c4-0800200c9a66",
 "createdDate" : "1332216000000",
 "createdBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "modifiedDate" : "1332216000000",
 "modifiedBy" : 
    {"id" : "91f46e39-cea8-422b-b215-00f6bcf5d280",
     "firstName" : "John",
     "lastName" : "Doe"},  
 "objectStatus" : "ACTIVE",
 "name" : "CAPSession",
 "description" : "CAP Session.",
 "sortOrder" : 1}

 

Delete a Journal Step

DELETE /ssp/api/1/reference/journalStep/{id}

Security

SERVICE_REFERENCE_WRITE

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}

 

Add a Journal Step Detail to a Journal Step

POST /ssp/api/1/reference/journalStep/{id}/journalStepDetail

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"journalStepDetailId" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6"}

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}


Remove a Journal Step Detail from a Journal Step

DELETE /ssp/api/1/reference/journalStep/{id}/journalStepDetail

Security

SERVICE_REFERENCE_WRITE

Sample Post

{"journalStepDetailId" : "aa4cbb22-f5bf-4510-8f99-9dfce1d2bba6"}

Returns

{"success" : "true"}

or

{"success" : "false", 
 "message" : "Message when success is false."}
  • No labels