Jump to

• Request
• Response
• Examples

Update a service

patch

/crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}

Request

Path Parameters

• ProviderId(required): integer(int64)
  The unique identifier of the service provider.
• ServiceId(required): integer(int64)
  The unique identifier of the service.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EstimatedStartTime: string (date-time)
  Title: Estimated Start Time

  The next estimated start time for the service state.
• LastAvailDate: string (date-time)
  Title: Last Available Date

  The date when the service was last available.
• ProviderId(required): integer (int64)
  Title: Provider ID

  The unique identifier of the service provider.
• serviceHistories: array Service Histories
  Title: Service Histories

  The service histories resource is used to view the historical information about the availability of a service.
• ServiceName(required): string
  Title: Service Name

  Maximum Length: 400

  The name of the service.
• ServiceStateCd: string
  Title: Service State Code

  Maximum Length: 64

  Default Value: UNAVAILABLE

  The code indicating the state of the service.

{
    "required":[
        "ProviderId",
        "ServiceName"
    ],
    "type":"object",
    "properties":{
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service was last available.",
            "format":"date-time",
            "nullable":true
        },
        "ProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"The unique identifier of the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ServiceName":{
            "title":"Service Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service.",
            "nullable":false
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":true,
            "default":"UNAVAILABLE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "serviceHistories":{
            "title":"Service Histories",
            "type":"array",
            "description":"The service histories resource is used to view the historical information about the availability of a service.",
            "items":{
                "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-patch-request"
            }
        }
    }
}

Nested Schema : Service Histories

Type: array

Title: Service Histories

The service histories resource is used to view the historical information about the availability of a service.

Show Source

• Array of: object serviceProviders-services-serviceHistories-item-patch-request

{
    "title":"Service Histories",
    "type":"array",
    "description":"The service histories resource is used to view the historical information about the availability of a service.",
    "items":{
        "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-patch-request"
    }
}

Nested Schema : serviceProviders-services-serviceHistories-item-patch-request

Type: object

Show Source

• EstimatedStartTime: string (date-time)
  Title: Estimated Start Time

  The next estimated start time for the service state.
• LastAvailDate: string (date-time)
  Title: Last Available Date

  The date when the service history was last available.

{
    "type":"object",
    "properties":{
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service history was last available.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : serviceProviders-services-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the service.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the service was created.
• EstimatedStartTime: string (date-time)
  Title: Estimated Start Time

  The next estimated start time for the service state.
• LastAvailDate: string (date-time)
  Title: Last Available Date

  The date when the service was last available.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the service was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProviderId: integer (int64)
  Title: Provider ID

  The unique identifier of the service provider.
• serviceHistories: array Service Histories
  Title: Service Histories

  The service histories resource is used to view the historical information about the availability of a service.
• ServiceId: integer (int64)
  Title: Service ID

  Read Only: true

  The unique identifier of the service.
• ServiceName: string
  Title: Service Name

  Maximum Length: 400

  The name of the service.
• ServiceStateCd: string
  Title: Service State Code

  Maximum Length: 64

  Default Value: UNAVAILABLE

  The code indicating the state of the service.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service was last available.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProviderId":{
            "title":"Provider ID",
            "type":"integer",
            "description":"The unique identifier of the service provider.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service ID",
            "type":"integer",
            "description":"The unique identifier of the service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceName":{
            "title":"Service Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":true,
            "default":"UNAVAILABLE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "serviceHistories":{
            "title":"Service Histories",
            "type":"array",
            "description":"The service histories resource is used to view the historical information about the availability of a service.",
            "items":{
                "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Service Histories

Type: array

Title: Service Histories

The service histories resource is used to view the historical information about the availability of a service.

Show Source

• Array of: object serviceProviders-services-serviceHistories-item-response

{
    "title":"Service Histories",
    "type":"array",
    "description":"The service histories resource is used to view the historical information about the availability of a service.",
    "items":{
        "$ref":"#/components/schemas/serviceProviders-services-serviceHistories-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : serviceProviders-services-serviceHistories-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the service history.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the service history was created.
• EstimatedStartTime: string (date-time)
  Title: Estimated Start Time

  The next estimated start time for the service state.
• HistoryId: integer (int64)
  Title: History ID

  Read Only: true

  The unique identifier of the service history.
• LastAvailDate: string (date-time)
  Title: Last Available Date

  The date when the service history was last available.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the service history was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the service history.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the service history.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ServiceId: integer (int64)
  Title: Service ID

  The unique identifier of the service to which the history belongs.
• ServiceStateCd: string
  Title: Service State Code

  Maximum Length: 64

  The code indicating the state of the service.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the service history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the service history was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedStartTime":{
            "title":"Estimated Start Time",
            "type":"string",
            "description":"The next estimated start time for the service state.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "HistoryId":{
            "title":"History ID",
            "type":"integer",
            "description":"The unique identifier of the service history.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastAvailDate":{
            "title":"Last Available Date",
            "type":"string",
            "description":"The date when the service history was last available.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the service history was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the service history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the service history.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServiceId":{
            "title":"Service ID",
            "type":"integer",
            "description":"The unique identifier of the service to which the history belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ServiceStateCd":{
            "title":"Service State Code",
            "maxLength":64,
            "type":"string",
            "description":"The code indicating the state of the service.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ServiceStateCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SERVICE_STATE_CD

The list of values indicating the state of a service,

The following properties are defined on the LOV link relation:

• Source Attribute: ServiceStateCd; Target Attribute: LookupCode
• Display Attribute: Meaning

serviceHistories

Operation: /crmRestApi/resources/11.13.18.05/serviceProviders/{ProviderId}/child/services/{ServiceId}/child/serviceHistories

Parameters:

• ProviderId: $request.path.ProviderId
• ServiceId: $request.path.ServiceId

The service histories resource is used to view the historical information about the availability of a service.

Back to Top

Examples

The following example shows how to update a service by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceProviders/child/services/300100123781596

Example of Request Body

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

{
"ServiceStateCd" : "UNAVAILABLE"
}

Example of Response Body

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

{
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-11-20T11:38:38+00:00",
"LastUpdateDate": "2017-11-20T11:42:47+00:00",
"LastUpdateLogin": "5E67CBDF62AB11EEE0538E09F20A463C",
"LastUpdatedBy": "SALES_ADMIN",
"ProviderId": 300100123753001,
"ServiceId": 300100123781596,
"EstimatedStartTime": null,
"LastAvailDate": "2017-11-20T11:38:38.011+00:00",
"ServiceName": "test service",
"ServiceStateCd": "UNAVAILABLE",
"links": [
 ...
 ]
}

Back to Top