Jump to

• Request
• Response

Get unhelpful objective details

post

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails

This method lets you get the details of objective which aren't helpful.

Request

Path Parameters

• PartyNumber(required): string
  The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• orchAssociationId: number
  The unique identifier of the orchestration association.
• orchStageObjId: number
  Orchestration stage objective identifier for which details are needed.

{
    "type":"object",
    "properties":{
        "orchAssociationId":{
            "type":"number",
            "description":"The unique identifier of the orchestration association.",
            "nullable":true
        },
        "orchStageObjId":{
            "type":"number",
            "description":"Orchestration stage objective identifier for which details are needed.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  Returns the objective details.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"Returns the objective details.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

Returns the objective details.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Returns the objective details.",
    "items":{
        "type":"string"
    }
}

Back to Top