observationJobs.create creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.
HTTP request
POST https://apim.googleapis.com/v1alpha/{parent=projects/*/locations/*}/observationJobs
Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location}
Query parameters
Parameters
observationJobId
string
Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
requestId
string
Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Request body
The request body contains an instance of ObservationJob.
Response body
If successful, the response body contains a newly created instance of Operation.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
IAM Permissions
Requires the following IAM permission on the parent resource:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis webpage details how to create a new ObservationJob using the \u003ccode\u003eobservationJobs.create\u003c/code\u003e method, which serves as a configuration for collecting API data.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to create an ObservationJob is a POST request to a specific URL, following gRPC Transcoding syntax, with the project and location specified in the path.\u003c/p\u003e\n"],["\u003cp\u003eThe creation of an ObservationJob requires specific parameters including \u003ccode\u003eparent\u003c/code\u003e as a path parameter, and \u003ccode\u003eobservationJobId\u003c/code\u003e and \u003ccode\u003erequestId\u003c/code\u003e as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include an instance of \u003ccode\u003eObservationJob\u003c/code\u003e, while the successful response will contain a newly created instance of \u003ccode\u003eOperation\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eCreating an ObservationJob requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003eapim.observationJobs.create\u003c/code\u003e on the parent resource.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.observationJobs.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n\nobservationJobs.create creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs.\n\n### HTTP request\n\n`POST https://apim.googleapis.com/v1alpha/{parent=projects/*/locations/*}/observationJobs`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [ObservationJob](/apigee/docs/reference/apis/apim/rest/v1alpha/projects.locations.observationJobs#ObservationJob).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/apigee/docs/reference/apis/apim/rest/v1alpha/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `apim.observationJobs.create`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
