Jump to

• Request
• Response
• Examples

Get a service request

get

/rest/ofscCore/v1/serviceRequests/{requestId}

This operation retrieves information about the specified service request.

Request

Path Parameters

• requestId(required): integer
  The identifier of the service request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Service Request

Type: object

Title: Service Request

The service request fields.

Show Source

• activityId: integer
  Title: Activity ID

  The activity ID specified in the request.
• created: string
  Title: Created Time

  The date and time (in "YYYY-MM-DD HH:MM:SS" format) when the service request is created in Oracle Field Service.
• date: string
  Title: Date

  The date when the service request is created.
• inventoryId: integer
  Title: Inventory ID

  The inventory ID specified in the request.
• requestId: integer
  Title: Request ID

  The specified identifier of the service request.
• requestType: string
  Title: Type

  The service request type specified in the request.
• resourceId: string
  Title: Resource ID

  The resource ID in external system.
• resourceInternalId: integer
  Title: Resource Internal ID

  The resource ID in Oracle Field Service. This field is read-only.

{
    "type":"object",
    "description":"The service request fields.",
    "title":"Service Request",
    "properties":{
        "requestId":{
            "type":"integer",
            "title":"Request ID",
            "description":"The specified identifier of the service request."
        },
        "resourceId":{
            "x-nullable":true,
            "type":"string",
            "description":"The resource ID in external system.",
            "title":"Resource ID"
        },
        "resourceInternalId":{
            "type":"integer",
            "description":"The resource ID in Oracle Field Service. This field is read-only.",
            "title":"Resource Internal ID"
        },
        "activityId":{
            "type":"integer",
            "description":"The activity ID specified in the request.",
            "title":"Activity ID"
        },
        "inventoryId":{
            "type":"integer",
            "description":"The inventory ID specified in the request.",
            "title":"Inventory ID"
        },
        "date":{
            "description":"The date when the service request is created.",
            "title":"Date",
            "type":"string"
        },
        "created":{
            "type":"string",
            "description":"The date and time (in \"YYYY-MM-DD HH:MM:SS\" format) when the service request is created in Oracle Field Service.",
            "title":"Created Time"
        },
        "requestType":{
            "type":"string",
            "title":"Type",
            "description":"The service request type specified in the request."
        }
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get a service request by submitting a GET request on the REST resource using cURL:

cURL command Example

curl -u 'clientId@instance:clientSecret' \
 -X GET \
 --url 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/serviceRequests/90909'

Response Header Example

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.2.7
Date: Mon, 18 Dec 2017 02:20:33 GMT
Content-Type: application/json; charset=utf-8

Response Body Example

The following shows an example of the response body in JSON format.

HTTP/1.1 200
{
    "requestId": 90909,
    "resourceId": "cable",
    "resourceInternalId": 284,
    "activityId":989898,
    "inventoryId": 4225269,
    "date": "2014-08-14",
    "created": "2014-08-14 16:50:08",
    "sr_subject" : "Small",
    "sr_body" : "Big",
    "requestType" : "IR",
    "CUSTOM_PROP1" : "property text value"
}

Back to Top