SAP Status API

Get All SAP Statuses

GET /ssp/api/1/reference/sapstatus

Security

REFERENCE_READ

Parameters

status : ALL, ACTIVE, INACTIVE
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",
"message":"",
"results":2,
"rows":
    [{"id":"0a90940a-43dd-19d4-8143-e0e9a0d700dc",
        "createdDate":1391047844055,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054223858,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code1","description":"code1",
		"code":"code1"},
    {"id":"0a90940a-43dd-19d4-8143-e0e9cf3900dd",
        "createdDate":1391047855929,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054227150,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code2",
        "description":"code2",
		"code":"code2"}
    ]
}

Get a SAP Status

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

Security

REFERENCE_READ

Returns

{"success":"true",
"message":"",
    [{"id":"0a90940a-43dd-19d4-8143-e0e9a0d700dc",
        "createdDate":1391047844055,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054223858,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code1",
		"description":"code1",
		"code":"code1"}
    ]
}

Create a SAP Status

POST /ssp/api/1/reference/sapstatus

Security

REFERENCE_WRITE

Sample Post

{"name":"code1",
 "description":"code1",
 "code":"code1"}

Returns

{"createdDate":1391047844055,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054223858,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code1",
		"description":"code1",
		"code":"code1"}
}

Save a SAP Status

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

Security

REFERENCE_WRITE

Sample Post

{"createdDate":1391047844055,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054223858,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code1",
		"description":"code1",
		"code":"code1"}
}

Returns

{"createdDate":1391047844055,
        "createdBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "modifiedDate":1391054223858,
        "modifiedBy":
            {"id":"0a90940a-3efc-175f-813e-fc1ac581000b",
            "firstName":"Amy",
            "lastName":"Administrator"},
        "objectStatus":"ACTIVE",
        "name":"code1",
		"description":"code1",
		"code":"code1"}
}

Delete a SAP Status

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

Security

REFERENCE_WRITE

Returns

{"success" : "true"}

or

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